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"}}},"JobDetailInfo":{"properties":{"begin_time":{"description":"任务创建时间。","maxLength":55,"minLength":1,"type":"string"},"desktop_name":{"description":"桌面名称。","readOnly":true,"type":"string"},"end_time":{"description":"任务结束时间。","maxLength":55,"minLength":1,"type":"string"},"entities":{"$ref":"#/definitions/JobEntities","description":"Job对象信息。例如:桌面ID、产品ID、用户名。"},"error_code":{"description":"任务执行失败时的错误码。","maxLength":55,"minLength":1,"type":"string"},"fail_reason":{"description":"任务失败原因。","maxLength":255,"minLength":1,"type":"string"},"id":{"description":"任务id。","maxLength":255,"minLength":0,"type":"string"},"ip_address":{"description":"ip地址。","readOnly":true,"type":"string"},"job_id":{"description":"任务ID。","maxLength":255,"minLength":1,"type":"string"},"job_type":{"description":"任务类型。","maxLength":55,"minLength":1,"type":"string"},"mac_address":{"description":"mac地址。","readOnly":true,"type":"string"},"message":{"description":"任务失败原因信息。","maxLength":255,"minLength":1,"type":"string"},"process":{"description":"任务进度。","readOnly":true,"type":"integer"},"status":{"description":"任务状态。","maxLength":55,"minLength":1,"type":"string"}}},"JobEntities":{"properties":{"desktop_id":{"description":"桌面ID。","maxLength":55,"minLength":1,"type":"string"},"product_id":{"description":"套餐ID。","maxLength":55,"minLength":1,"type":"string"},"user_name":{"description":"用户名。","maxLength":55,"minLength":1,"type":"string"}},"type":"object"},"ShowJobRsp":{"description":"查询任务详情响应","properties":{"begin_time":{"description":"任务开始时间","readOnly":true,"type":"string"},"end_time":{"description":"任务结束时间","readOnly":true,"type":"string"},"fail_reason":{"description":"任务失败原因","readOnly":true,"type":"string"},"id":{"description":"任务ID","readOnly":true,"type":"string"},"job_error_code":{"description":"任务错误码","readOnly":true,"type":"string"},"job_type":{"description":"任务类型","readOnly":true,"type":"string"},"status":{"description":"任务状态","readOnly":true,"type":"string"},"sub_jobs":{"description":"子任务列表","items":{"$ref":"#/definitions/JobDetailInfo"},"readOnly":true,"type":"array"},"sub_jobs_total":{"description":"子任务总数","format":"int32","readOnly":true,"type":"integer"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"05d6c0540d5642f6b6416ca838660c29","info_version":"v2","method":"get","name":"ShowJob","parameters":{},"paths":{"/v2/{project_id}/workspace-jobs/{job_id}":{"get":{"description":"该接口用于查询异步任务的执行情况,比如查询创建桌面任务的执行状态。","operationId":"ShowJob","parameters":[{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":40000,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-annotations":"@Size(max = 40000, min = 1)","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX...","x-is-registered":"N"},{"description":"发送的实体的MIME类型","in":"header","maxLength":255,"minLength":1,"name":"Content-Type","required":true,"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":"任务ID。","in":"path","maxLength":255,"minLength":1,"name":"job_id","required":true,"type":"string","x-annotations":"@Size(max = 255, min = 1)","x-example":"2382dd96-xxxxx56d-axxxc4b09a35b58"}],"responses":{"200":{"description":"查询任务详情响应","examples":{"application/json":{}},"schema":{"$ref":"#/definitions/ShowJobRsp"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/BaseResponse"}},"default":{"description":"默认失败响应","schema":{"$ref":"#/definitions/BaseResponse"}}},"schemes":["https"],"summary":"查询任务详情","tags":["Jobs"],"x-addValid":true,"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-request-examples-url-1":"GET /v2/ac234de25c6741d2b1273da49eea1b9e/workspace-jobs/2382dd96-xxxxx56d-axxxc4b09a35b58","x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询任务详情","tags":"任务","uri":null,"version":"2.0"}