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\"]","definitions":{"BaseError":{"description":"API响应基类,用于老接口200响应,对文档不呈现","properties":{"error_code":{"description":"错误码,失败时返回。","maxLength":255,"minLength":0,"type":"string","x-is_inner_param":"True"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string","x-is_inner_param":"True"}}},"BaseResponse":{"description":"API响应基类","properties":{"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"CbcCallbackRsp":{"allOf":[{"$ref":"#/definitions/BaseError"},{"properties":{"cbcJobId":{"description":"创建云桌面总任务ID,CBC根据此ID定期查询任务是否成功","maxLength":255,"minLength":1,"type":"string","x-annotations":["@JsonProperty(\"jobId\")"],"x-is_inner_param":"True","x-onlyCustomAnnotation":true},"getJobEndpoint":{"description":"云运营平台CBC获取到JobId后,会使用getJobEndpoint当做URL,调用云服务,查询获取Job结果","maxLength":255,"minLength":1,"type":"string","x-is_inner_param":"True"},"maxProvisionTime":{"default":360,"description":"在线开通最大时间 在maxProvisionTime时间范围内,CBC会周期性的查询云服务开通结果;超过maxProvisionTime还没有开通成功,CBC会发失败工单,人工去分析处理。 单位:分钟。 如果为空,CBC默认为6小时。 取值范围(0,43200],即30天。","format":"int32","maximum":43200,"minimum":0,"type":"integer","x-is_inner_param":"True"},"minProvisionTime":{"default":5,"description":"开通最小时间(云服务最快开通时长,或一般开通时长) 获取到JobId后,经过minProvisionTime时间后,才来查询获取云服务开通结果。如果为空,云运营平台获取到JobId后,就去查询云服务开通结果。 单位:分钟。 取值范围:(0, 43200)","format":"int32","maximum":43200,"minimum":0,"type":"integer","x-is_inner_param":"True"},"periodicQueryTime":{"default":2,"description":"Job周期性查询时间,默认2分钟查询一次 云运营平台会使用getJobEndpoint(Job查询接口)、每隔periodicQueryTime时间去查询云服务开通结果。 单位:分钟。 如果为空,则使用CBC默认的间隔时间(1分钟,2分钟,4分钟......15分钟)来查询云服务开通结果。 取值范围:(0, 43200)","format":"int32","maximum":43200,"minimum":0,"type":"integer","x-is_inner_param":"True"}},"type":"object"}],"description":"CBC回调创建包周期桌面时的响应体。注意:根据云运营平台的API规范,部分参数为驼峰型,不能修改为下划线连接,API规范检查时需要忽略。","x-is_inner_param":"True"},"ExpandDesktopPoolVolumesReq":{"description":"扩容桌面池磁盘请求。","properties":{"order_id":{"description":"包周期订购ID,CBC订购回调时使用。","maxLength":255,"minLength":1,"type":"string","x-is_inner_param":"True"},"volumes":{"description":"扩容的桌面池磁盘列表。","items":{"$ref":"#/definitions/VolumeInfo"},"maxItems":11,"minItems":0,"type":"array"}}},"ExpandDesktopPoolVolumesRsp":{"allOf":[{"$ref":"#/definitions/CbcCallbackRsp"},{"properties":{"job_id":{"description":"任务ID","readOnly":true,"type":"string"}},"type":"object"}],"description":"扩容桌面池磁盘响应。"},"VolumeInfo":{"description":"磁盘信息。","properties":{"cluster_id":{"description":"云服务器系统盘对应的存储池的ID。","maxLength":255,"minLength":0,"type":"string","x-is_inner_param":"True"},"id":{"description":"批量操作磁盘的磁盘集合id。","maxLength":255,"minLength":1,"type":"string"},"resource_spec_code":{"description":"规格","maxLength":255,"minLength":0,"type":"string"},"size":{"description":"磁盘容量,单位GB。","maximum":8200,"minimum":0,"type":"integer"},"type":{"description":"桌面数据盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。\n- SAS:高IO。\n- SSD:超高IO。","maxLength":255,"minLength":1,"type":"string"}},"required":["type","size"]}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"e7f80c1afe504135929649d923954a98","info_version":"v2","method":"post","name":"ExpandDesktopPoolVolumes","parameters":{"Service-Transaction-Id":{"description":"CBC接口回调时,请求头里带上的业务ID","in":"header","maxLength":15000,"minLength":1,"name":"Service-Transaction-Id","required":false,"type":"string","x-example":"2b31e-d520xxxx-xxebedb6-e57xxxxxx","x-is_inner_param":"True"},"X-Auth-Token":{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":40000,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},"pool_id":{"description":"桌面池ID。","in":"path","maxLength":255,"minLength":1,"name":"pool_id","required":true,"type":"string","x-annotations":"@Size(max = 255, min = 1)","x-example":"2b31e-d520xxxx-xxebedb6-e57xxxxxx"},"project_id":{"description":"项目ID。","in":"path","maxLength":255,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"}},"paths":{"/v2/{project_id}/desktop-pools/{pool_id}/volumes/batch-expand":{"post":{"description":"桌面池批量扩容磁盘。","operationId":"ExpandDesktopPoolVolumes","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"$ref":"#/parameters/Service-Transaction-Id"},{"$ref":"#/parameters/project_id"},{"$ref":"#/parameters/pool_id"},{"description":"桌面池批量扩容磁盘。","in":"body","name":"ExpandDesktopPoolVolumesRequestBody","required":true,"schema":{"$ref":"#/definitions/ExpandDesktopPoolVolumesReq"}}],"responses":{"200":{"description":"正常","examples":{"application/json":{"job_id":"abc85365-0b2e-4b4f-a091-f7db72072d4b"}},"schema":{"$ref":"#/definitions/ExpandDesktopPoolVolumesRsp"}},"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":["DesktopPool"],"x-apiexplorer-hide":"N","x-apig-group":"public,internal_token,internal_appcode","x-apigateway-request-type":"public","x-is-registered":"Y","x-methodAnnotations":["@EnableAuth","@WksIamAuthMeta(resourceType=ResourceType.DESKTOP_POOL, resourceField=\"pool_id\")","@IamAuthMeta(authLevel = IamAuthLevel.INSTANCE, abacAction = \"workspace:desktopPools:batchExpandVolumes\", needApigwJwtAuthCheck = false, authContextInitializerName = \"workspaceInstanceAuthContextInitializer\", needRbacCheck = false, needAbacResourceCheck = true)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"expandDesktopPoolVolumes\")"],"x-request-examples-1":{"volumes":[{"cluster_id":"","device":"/dev/vda","size":100,"type":"SAS"},{"cluster_id":"","device":"/dev/vdb","size":100,"type":"SAS"},{"cluster_id":"","device":"/dev/vdc","size":200,"type":"SAS"}]},"x-request-examples-text-1":{"volumes":[{"cluster_id":"","device":"/dev/vda","size":100,"type":"SAS"},{"cluster_id":"","device":"/dev/vdb","size":100,"type":"SAS"},{"cluster_id":"","device":"/dev/vdc","size":200,"type":"SAS"}]},"x-support-sdk":"Y","x-workspace-api-auth":"CBC"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"桌面池批量扩容磁盘","tags":"桌面池","uri":null,"version":"2.0"}