huawei-cloud-api-definitions-Workspace 0.1.20260116

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\",\"application/json;charset=utf-8\",\"application/json;charset=UTF-8\"]","definitions":{"AddDesktopVolumesReq":{"description":"单个桌面添加磁盘参数。","properties":{"desktop_id":{"description":"桌面Id。","maxLength":255,"minLength":0,"type":"string"},"volumes":{"description":"待新增的磁盘信息,每个桌面的数据盘数量不超过10个。","items":{"$ref":"#/definitions/Volume"},"maxItems":10,"minItems":1,"type":"array","x-maxLength":10,"x-minLength":1}}},"AddDesktopsVolumesReq":{"description":"增加磁盘请求。","properties":{"desktop_volumes":{"description":"新增磁盘参数。","items":{"$ref":"#/definitions/AddDesktopVolumesReq"},"maxItems":100,"minItems":0,"type":"array"}}},"AddDesktopsVolumesRsp":{"properties":{"job_id":{"description":"增加磁盘任务ID。","maxLength":255,"minLength":1,"type":"string"}}},"BaseResponse":{"description":"API响应基类。","properties":{"encoded_authorization_message":{"description":"加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。","readOnly":true,"type":"string"},"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_detail":{"description":"错误详情。","maxLength":1000,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"Volume":{"description":"磁盘。","properties":{"iops":{"description":"iops,云硬盘每秒进行读写的操作次数。","maximum":16380000,"minimum":0,"type":"integer"},"kms_id":{"description":"kms密钥id,对创建的磁盘进行加密。","maxLength":255,"minLength":0,"type":"string"},"size":{"description":"磁盘容量,单位GB。系统盘大小范围[80-32760],数据盘范围[10-32760],大小为10的倍数。","maximum":32760,"minimum":10,"type":"integer"},"throughput":{"description":"吞吐量,云硬盘每秒成功传送的数据量,即读取和写入的数据量。","maximum":4095000,"minimum":0,"type":"integer"},"type":{"description":"桌面数据盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。\n\n-SAS:高IO。\n-SSD:超高IO。\n-GPSSD:通用型SSD。","maxLength":255,"minLength":1,"type":"string"}},"required":["size","type"]}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"31a04d2be8c94d86b73ea90d32064740","info_version":"v2","method":"post","name":"AddVolumes","parameters":{},"paths":{"/v2/{project_id}/volumes":{"post":{"description":"批量增加桌面磁盘。","operationId":"AddVolumes","parameters":[{"description":"项目ID。","in":"path","maxLength":255,"minLength":1,"name":"project_id","required":true,"type":"string","x-annotations":"@Size(max = 255, min = 1)","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"添加磁盘请求。","in":"body","name":"AddVolumesRequestBody","required":true,"schema":{"$ref":"#/definitions/AddDesktopsVolumesReq"}}],"responses":{"200":{"description":"正常。","examples":{"application/json":{"job_id":"1792d3eb-35c6-4e99-8381-abfc8e02126b"}},"schema":{"$ref":"#/definitions/AddDesktopsVolumesRsp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResponse"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/BaseResponse"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/BaseResponse"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/BaseResponse"}},"409":{"description":"操作冲突。","schema":{"$ref":"#/definitions/BaseResponse"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/BaseResponse"}}},"schemes":["https"],"summary":"批量增加桌面磁盘","tags":["Volume"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"public,internal_token","x-apigateway-request-type":"public","x-is-registered":"Y","x-methodAnnotations":["@EnableAuth","@WksIamAuthMeta(resourceField = \"desktopVolumes.![desktopId]\")","@IamAuthMeta(authLevel = IamAuthLevel.INSTANCE_LIST, abacAction = \"workspace:volumes:batchAdd\", needApigwJwtAuthCheck = false, authContextInitializerName = \"workspaceInstanceListAuthContextInitializer\", needRbacCheck = false, needAbacResourceCheck = true)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"addVolumes\", traceNameCn = \"批量增加桌面磁盘\")"],"x-request-examples-1":{"desktop_volumes":[{"desktop_id":"string","volumes":[{"size":80,"type":"SAS"}]}]},"x-request-examples-text-1":{"desktop_volumes":[{"desktop_id":"string","volumes":[{"size":80,"type":"SAS"}]}]},"x-request-examples-url-1":"POST /v2/9565be6e740941c493b38a1f46ecae6f/volumes","x-support-hcs":"Y","x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-used-authn5":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-opt":{"inner-auth-type":"iam_auth_n5"},"x-apigateway-auth-type":"IAM"}},"summary":"批量增加桌面磁盘","tags":"磁盘","uri":null,"version":"2.0"}