huawei-cloud-api-definitions-Workspace 0.1.20240127

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"}}},"BatchActionDesktopsOldRsp":{"description":"批量操作桌面响应。","properties":{"failed_operation_list":{"description":"操作失败桌面列表。","items":{"$ref":"#/definitions/VmOperateResult"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"job_id":{"description":"任务ID,冷迁移启动时返回。","maxLength":255,"minLength":0,"type":"string"}}},"BatchActionDesktopsReq":{"description":"批量操作桌面请求。","properties":{"desktop_ids":{"description":"操作的桌面ID列表。","items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":1,"type":"array","x-maxLength":100,"x-minLength":1},"op_type":{"description":"操作类型。\n-os-start 启动。\n-reboot 重启。\n-os-stop 关机。\n-os-hibernate 休眠。","maxLength":55,"minLength":1,"type":"string"},"type":{"description":"SOFT:普通操作;HARD:强制操作。例如type为HARD,op_type为os-stop代表强制关机。","enum":["SOFT","HARD"],"maxLength":55,"minLength":1,"type":"string"}},"required":["desktop_ids","op_type"]},"VmOperateResult":{"description":"操作失败的桌面列表。","properties":{"desktop_id":{"description":"桌面ID。","maxLength":255,"minLength":0,"type":"string"},"desktop_name":{"description":"桌面名称。","maxLength":255,"minLength":0,"type":"string"},"error_code":{"description":"操作失败的错误码。","maxLength":255,"minLength":0,"type":"string"},"error_msg":{"description":"操作失败的原因描述。","maxLength":1000,"minLength":0,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"4f3d30ee806c4512a6735c76c948c351","info_version":"v2","method":"post","name":"BatchRunDesktops","parameters":{},"paths":{"/v2/{project_id}/desktops/action":{"post":{"description":"批量操作桌面,用于批量开机、关机和重启。","operationId":"BatchRunDesktops","parameters":[{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":15000,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-annotations":"@Size(max = 15000, min = 1)","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX...","x-is-registered":"N"},{"description":"发送的实体的MIME类型。","in":"header","maxLength":255,"minLength":1,"name":"Content-Type","required":false,"type":"string","x-annotations":"@Size(max = 255, min = 1)","x-example":"application/json"},{"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":"BatchRunDesktopsRequestBody","required":true,"schema":{"$ref":"#/definitions/BatchActionDesktopsReq"}}],"responses":{"200":{"description":"正常","examples":{"application/json":{"job_id":"abc85365-0b2e-4b4f-a091-f7db72072d4b"}},"schema":{"$ref":"#/definitions/BatchActionDesktopsOldRsp"}},"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":["Desktop"],"x-apiexplorer-hide":"N","x-apig-group":"public,internal_token","x-apigateway-request-type":"public","x-is-registered":"Y","x-request-examples-1":{"desktop_ids":["f77db5cd-c020-47d4-bbbe-9b979a38d18c","f77db5cd-c020-47d4-bbbe-9b979a38d18b"],"op_type":"os-stop","type":"SOFT"},"x-request-examples-text-1":{"desktop_ids":["f77db5cd-c020-47d4-bbbe-9b979a38d18c","f77db5cd-c020-47d4-bbbe-9b979a38d18b"],"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"}