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":{"BaseJobResponse":{"description":"不携带错误码的基本任务响应体。","properties":{"job_id":{"description":"任务ID。","maxLength":255,"minLength":0,"type":"string"}}},"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"}}},"BatchCreateDesktopSnapshotReq":{"description":"批量创建快照请求体。","properties":{"data_disk_snapshot":{"$ref":"#/definitions/DiskSnapshotInfo"},"desktop_ids":{"description":"桌面id数组,最多支持100。","example":["xxxx3bc6-1512-4386-81fb-20604fe6xxxx"],"items":{"maxLength":36,"minLength":1,"type":"string"},"maxItems":100,"minItems":1,"type":"array","x-maxLength":100,"x-minLength":1,"x-type":"List<@Size(min=1, max=36) String>"},"disk_type":{"description":"快照类型。\n- SYSTEM_DISK 系统盘。\n- DATA_DISKS 数据盘。\n- ALL 系统盘和数据盘。","enum":["SYSTEM_DISK","DATA_DISKS","ALL"],"maxLength":55,"minLength":1,"type":"string"},"system_disk_snapshot":{"$ref":"#/definitions/DiskSnapshotInfo"}}},"DiskSnapshotInfo":{"description":"磁盘快照信息。","properties":{"description":{"description":"磁盘快照描述。","maxLength":255,"minLength":0,"type":"string"},"name":{"description":"磁盘快照名称,批量操作时最终名称为:桌面名称+磁盘快照名称+时间戳。","maxLength":64,"minLength":0,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"c1429a245385486ab4e140d63e324b9e","info_version":"v2","method":"post","name":"BatchCreateDesktopSnapshot","parameters":{},"paths":{"/v2/{project_id}/snapshots/batch-create":{"post":{"description":"批量创建快照。","operationId":"BatchCreateDesktopSnapshot","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...","x-is-registered":"N"},{"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":"BatchCreateDesktopSnapshotRequestBody","required":true,"schema":{"$ref":"#/definitions/BatchCreateDesktopSnapshotReq"}}],"responses":{"200":{"description":"OK。","examples":{"application/json":{"job_id":"1792d3eb-35c6-4e99-8381-abfc8e02126b"}},"schema":{"$ref":"#/definitions/BaseJobResponse"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResponse"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/BaseResponse"}},"409":{"description":"操作冲突。","schema":{"$ref":"#/definitions/BaseResponse"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/BaseResponse"}},"default":{"description":"默认失败响应。","schema":{"$ref":"#/definitions/BaseResponse"}}},"summary":"批量创建快照","tags":["Snapshot"],"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-methodAnnotations":["@EnableAuth","@WksIamAuthMeta(resourceType = ResourceType.DESKTOP, resourceField=\"desktopIds\")","@IamAuthMeta(authLevel = IamAuthLevel.INSTANCE_LIST, abacAction = \"workspace:desktops:batchCreateSnapshots\",  needApigwJwtAuthCheck = false, authContextInitializerName = \"workspaceInstanceListAuthContextInitializer\", needRbacCheck = false, needAbacResourceCheck = true)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"batchCreateSnapshot\")"],"x-request-examples-1":{"data_disk_snapshot":{"description":"string","name":"string"},"desktop_ids":["xxxx3bc6-1512-4386-81fb-20604fe6xxxx"],"disk_type":"string","system_disk_snapshot":{"description":"string","name":"string"}},"x-request-examples-text-1":{"data_disk_snapshot":{"description":"string","name":"string"},"desktop_ids":["xxxx3bc6-1512-4386-81fb-20604fe6xxxx"],"disk_type":"string","system_disk_snapshot":{"description":"string","name":"string"}},"x-support-sdk":"Y"}}},"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"}