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":{"AddDesktopSubResourcesReq":{"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,"x-type":"List<@Size(min=0, max=255) String>"},"order_id":{"description":"订单ID。","maxLength":255,"minLength":0,"type":"string"},"sub_resource_sku":{"description":"桌面协同资源SKU码。","maxLength":255,"minLength":0,"type":"string"}},"required":["desktop_ids","sub_resource_sku"]},"AddDesktopSubResourcesRsp":{"allOf":[{"$ref":"#/definitions/CreateDesktopRsp"}],"description":"桌面购买协同资源响应体。"},"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"}}},"CreateDesktopRsp":{"description":"创建按需桌面时的响应体,可根据job_id查询资源是否创建成功。","properties":{"job_id":{"description":"创建云桌面总任务id。","maxLength":255,"minLength":1,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"a276e6036dc848c3a71c3954eb2e997d","info_version":"v2","method":"post","name":"AddDesktopSubResources","parameters":{"Content-Type":{"description":"发送的实体的MIME类型,如:application/json。","in":"header","maxLength":255,"minLength":1,"name":"Content-Type","required":true,"type":"string","x-example":"application/json"},"X-Auth-Token":{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":64000,"minLength":1,"name":"X-Auth-Token","required":false,"type":"string","x-annotations":["@Size(max = 64000, min = 1)"],"x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},"project_id":{"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"}},"paths":{"/v2/{project_id}/desktop/sub-resources":{"post":{"description":"存量桌面购买附属资源。","operationId":"AddDesktopSubResources","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"$ref":"#/parameters/Content-Type"},{"$ref":"#/parameters/project_id"},{"description":"桌面购买附属资源请求。","in":"body","name":"AddDesktopSubResourcesRequestBody","required":true,"schema":{"$ref":"#/definitions/AddDesktopSubResourcesReq"}}],"responses":{"200":{"description":"桌面购买协同响应。","examples":{"application/json":{"job_id":"3979904c-7beb-4f34-835f-2fa989a5550a"}},"schema":{"$ref":"#/definitions/AddDesktopSubResourcesRsp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResponse"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/BaseResponse"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/BaseResponse"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/BaseResponse"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/BaseResponse"}}},"schemes":["https"],"summary":"桌面购买附属资源","tags":["ShareDesktop"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"public,internal_token,internal_appcode","x-apigateway-request-type":"public","x-imports":["com.huawei.workspace.auth.iam5.WksIamAuthMeta","com.huawei.workspace.auth.iam5.OperationType","com.huawei.workspace.auth.iam5.ResourceType","com.huawei.clouds.wushan.auth.token.IamAuthMeta","com.huawei.clouds.wushan.auth.token.IamAuthLevel","com.huawei.clouds.wushan.integration.common.auth.EnableAuth","com.huawei.clouds.wushan.cts.meta.CtsMeta"],"x-is-registered":"Y","x-methodAnnotations":["@EnableAuth","@WksIamAuthMeta(resourceType = ResourceType.DESKTOP, resourceField=\"desktopIds\")","@IamAuthMeta(authLevel = IamAuthLevel.INSTANCE_LIST, abacAction = \"workspace:desktops:addSubResources\",  needApigwJwtAuthCheck = false, authContextInitializerName = \"workspaceInstanceListAuthContextInitializer\", needRbacCheck = false, needAbacResourceCheck = true)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"addDesktopsSubResources\")"],"x-request-examples-1":{"desktop_ids":["string"],"order_id":"string","sub_resource_sku":"string"},"x-request-examples-text-1":{"desktop_ids":["string"],"order_id":"string","sub_resource_sku":"string"},"x-support-sdk":"Y","x-workspace-api-auth":"CBC"}}},"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"}