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\"]","definitions":{"BaseResponse":{"description":"API响应基类","properties":{"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"DesktopPoolActionReq":{"description":"操作桌面池请求。","properties":{"op_type":{"description":"操作类型。\n-os-start 开机。\n-os-stop 关机。\n-reboot 重启。\n-hibernate 休眠。","maxLength":55,"minLength":1,"type":"string"},"type":{"description":"执行类型。例如type为HARD,op_type为os-stop代表强制关机。\n- SOFT:普通操作。\n- HARD:强制操作。","enum":["SOFT","HARD"],"maxLength":55,"minLength":1,"type":"string"}},"required":["op_type"]},"DesktopPoolActionRsp":{"description":"批量操作桌面响应。","properties":{"job_id":{"description":"任务ID。","readOnly":true,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"fd96ad90c22941cea875de8ac4d48448","info_version":"v2","method":"post","name":"ExecuteDesktopPoolAction","parameters":{"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}/action":{"post":{"description":"操作桌面池,用于桌面池里面的桌面批量开机、关机、重启和休眠。","operationId":"ExecuteDesktopPoolAction","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"$ref":"#/parameters/project_id"},{"$ref":"#/parameters/pool_id"},{"description":"操作桌面池。","in":"body","name":"ExecuteDesktopPoolActionRequestBody","required":true,"schema":{"$ref":"#/definitions/DesktopPoolActionReq"}}],"responses":{"200":{"description":"正常","examples":{"application/json":{"job_id":"abc85365-0b2e-4b4f-a091-f7db72072d4b"}},"schema":{"$ref":"#/definitions/DesktopPoolActionRsp"}},"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","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:operate\", needApigwJwtAuthCheck = false, authContextInitializerName = \"workspaceInstanceAuthContextInitializer\", needRbacCheck = false, needAbacResourceCheck = true)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"executeDesktopPoolAction\")"],"x-request-examples-1":{"op_type":"os-stop","type":"SOFT"},"x-request-examples-text-1":{"op_type":"os-stop","type":"SOFT"},"x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"操作桌面池","tags":"桌面池","uri":null,"version":"2.0"}