huawei-cloud-api-definitions-Workspace 0.1.20260425

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\",\"application/json;charset=utf-8\",\"application/json;charset=UTF-8\"]","definitions":{"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_detail":{"description":"错误详情。","maxLength":1000,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"DeleteDesktopsReq":{"description":"批量删除桌面请求。","properties":{"delete_users":{"default":false,"description":"删除桌面后,如果当前用户没有其它桌面,可以删除桌面用户。true:删除用户,false:不删除用户,默认为false。","type":"boolean"},"desktop_ids":{"description":"待删除的桌面ID列表。","items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":1,"type":"array","x-maxLength":100,"x-minLength":1,"x-type":"List<@Size(min=0, max=255) String>"},"email_notification":{"default":true,"description":"是否邮件通知,true:邮件通知,false:不通知,默认值true。","type":"boolean"},"is_force_delete":{"default":false,"description":"是否强制删除,true:强制删除,false:不强制删除。","type":"boolean"}},"required":["desktop_ids"]},"DeleteDesktopsRsp":{"properties":{"job_id":{"description":"任务ID。","maxLength":255,"minLength":0,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"2e070638b6954ce7830335af8f2a8e99","info_version":"v2","method":"post","name":"BatchDeleteDesktops","parameters":{},"paths":{"/v2/{project_id}/desktops/batch-delete":{"post":{"description":"批量删除桌面,删除后无法恢复。","operationId":"BatchDeleteDesktops","parameters":[{"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":"BatchDeleteDesktopsRequestBody","required":true,"schema":{"$ref":"#/definitions/DeleteDesktopsReq"}}],"responses":{"202":{"description":"正常。","examples":{"application/json":{"job_id":"abc85365-0b2e-4b4f-a091-f7db72072d4b"}},"schema":{"$ref":"#/definitions/DeleteDesktopsRsp"}},"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-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(resourceField = \"desktopIds\")","@IamAuthMeta(authLevel = IamAuthLevel.INSTANCE_LIST, abacAction = \"workspace:desktops:batchDelete\",  needApigwJwtAuthCheck = false, authContextInitializerName = \"workspaceInstanceListAuthContextInitializer\", needRbacCheck = false, needAbacResourceCheck = true, opType = \"query\")","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"deleteDesktops\", traceNameCn = \"批量删除桌面\")"],"x-request-examples-1":{"desktop_ids":["1d81c1dc-312b-4621-b778-bac3a1336442","34e25501-fd50-42b5-97ca-f4c5bb7b09b0"]},"x-request-examples-text-1":{"desktop_ids":["1d81c1dc-312b-4621-b778-bac3a1336442","34e25501-fd50-42b5-97ca-f4c5bb7b09b0"]},"x-request-examples-url-1":"POST /v2/29dfe82ada564ac2b927e1ff036d9a9b/desktops/batch-delete","x-support-hcs":"Y","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"}