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":{"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"}}},"CreateRemoteAssistanceRsp":{"description":"创建协同空间响应体。","properties":{"desktop_id":{"description":"桌面的desktopId。","maxLength":255,"minLength":0,"type":"string"},"initiator_type":{"description":"发起方类型\n- ADMIN_INITIATE 管理员发起\n- ENDUSER_INITIATE 终端用户发起","maxLength":255,"minLength":0,"type":"string"},"share_space_id":{"description":"协同空间ID。","maxLength":255,"minLength":0,"readOnly":true,"type":"string"},"status":{"description":"协同空间状态\n- OPEN 协同空间已创建\n- CLOSE 协同空间已关闭\n- WAIT_USER_CONFIRM 等待用户确认进入远程协助\n- WAIT_USER_ACCESS 等待用户进入远程协助","maxLength":255,"minLength":0,"readOnly":true,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"7a09f2e2b1244467b8c3fc8e8efb2407","info_version":"v2","method":"post","name":"CreateRemoteAssistance","parameters":{},"paths":{"/v2/{project_id}/desktops/{desktop_id}/remote-assistance":{"post":{"description":"创建远程协助。","operationId":"CreateRemoteAssistance","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":"用户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":"发送的实体的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":"desktop_id","required":true,"type":"string","x-annotations":"@Size(max = 255, min = 1)","x-example":"2b31e-d520xxxx-xxebedb6-e57xxxxxx"}],"responses":{"200":{"description":"正常。","examples":{"application/json":{"desktop_id":"a130ab3a-72bf-4b71-baa9-af4987c8e338","initiator_type":"ADMIN_INITIATE","share_space_id":"abvccch3jk12h3kj123hkj12","status":"OPEN"}},"schema":{"$ref":"#/definitions/CreateRemoteAssistanceRsp"}},"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":["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 = \"desktop_id\")","@IamAuthMeta(authLevel = IamAuthLevel.INSTANCE, abacAction = \"workspace:desktops:createRemoteAssistance\",  needApigwJwtAuthCheck = false, authContextInitializerName = \"workspaceInstanceAuthContextInitializer\", needRbacCheck = false, needAbacResourceCheck = true)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"createRemoteAssistance\")"],"x-request-examples-url-1":"/v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/a130ab3a-72bf-4b71-baa9-af4987c8e338/remote-assistance","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"}