huawei-cloud-api-definitions-Workspace 0.1.20250711

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\",\"application/json;charset=utf-8\"]","definitions":{"AddDesktopPoolVolumesReq":{"description":"扩容桌面池请求。","properties":{"volumes":{"description":"增加的磁盘列表。","items":{"$ref":"#/definitions/VolumeAddInfo"},"maxItems":10,"minItems":0,"type":"array","x-maxLength":10,"x-minLength":0}}},"AddDesktopPoolVolumesRsp":{"allOf":[{"$ref":"#/definitions/CbcCallbackRsp"},{"properties":{"job_id":{"description":"任务ID。","readOnly":true,"type":"string"}},"type":"object"}],"description":"增加磁盘响应。"},"BaseError":{"description":"API响应基类,用于老接口200响应,对文档不呈现。"},"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_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"CbcCallbackRsp":{"allOf":[{"$ref":"#/definitions/BaseError"},{"type":"object"}],"description":"CBC回调创建包周期桌面时的响应体。注意:根据云运营平台的API规范,部分参数为驼峰型,不能修改为下划线连接,API规范检查时需要忽略。","x-is_inner_param":"True"},"VolumeAddInfo":{"description":"磁盘信息。","properties":{"id":{"description":"磁盘记录ID,删除或者扩容磁盘时必选。","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":["size","type"]}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"9c92bbde8b0949389a467c46ddaf0f7b","info_version":"v2","method":"post","name":"AddDesktopPoolVolumes","parameters":{},"paths":{"/v2/{project_id}/desktop-pools/{pool_id}/volumes/batch-add":{"post":{"description":"桌面池批量添加磁盘。","operationId":"AddDesktopPoolVolumes","parameters":[{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":40000,"minLength":1,"name":"X-Auth-Token","required":false,"type":"string","x-annotations":"@Size(max = 40000, min = 1)","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"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":"桌面池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"},{"description":"桌面池批量添加磁盘。","in":"body","name":"AddDesktopPoolVolumesRequestBody","required":true,"schema":{"$ref":"#/definitions/AddDesktopPoolVolumesReq"}}],"responses":{"200":{"description":"正常。","examples":{"application/json":{"job_id":"abc85365-0b2e-4b4f-a091-f7db72072d4b"}},"schema":{"$ref":"#/definitions/AddDesktopPoolVolumesRsp"}},"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-api-type":"open-api","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:batchAddVolumes\", needApigwJwtAuthCheck = false, authContextInitializerName = \"workspaceInstanceAuthContextInitializer\", needRbacCheck = false, needAbacResourceCheck = true)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"addDesktopPoolVolumes\")"],"x-request-examples-1":{"volumes":[{"id":"9969022b-557d-4c1e-b22f-e7736ebe30af","size":20,"type":"SAS"}]},"x-request-examples-text-1":{"volumes":[{"id":"9969022b-557d-4c1e-b22f-e7736ebe30af","size":20,"type":"SAS"}]},"x-support-sdk":"Y","x-workspace-api-auth":"CBC"}}},"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"}