文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面/ 根据桌面id查询远程协助信息
更新时间：2024-12-12 GMT+08:00
查看PDF
分享

根据桌面id查询远程协助信息

功能介绍

根据桌面id查询远程协助信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/desktops/{desktop_id}/remote-assistance

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

desktop_id

是

String

桌面ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

否

String

发送的实体的MIME类型。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

share_space_id

String

协同空间ID

invitation_code

String

协同空间邀请码(大写英文+数字,共8位)

share_space_name

String

协同空间名称

share_space_passwd

String

协同空间密码

private_share_link

String

专线分享链接

internet_share_link

String

互联网分享链接

create_time

String

创建时间 UTC时间，格式为：yyyy-MM-dd'T'HH:mm:ss'Z'。

status

String

协同空间状态

  • OPEN 协同空间已创建

  • CLOSE 协同空间已关闭

  • WAIT_USER_CONFIRM 等待用户确认进入远程协助

  • WAIT_USER_ACCESS 等待用户进入远程协助

failed_reason

String

失败原因

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

/v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/a130ab3a-72bf-4b71-baa9-af4987c8e338/remote-assistance

响应示例

状态码： 200

正常

{
  "share_space_id" : "abvccch3jk12h3kj123hkj12",
  "invitation_code" : "D1F32AA6",
  "share_space_name" : "testShareSpaceName",
  "private_share_link" : "https://127.0.0.1:9445/#/share-space?username=xxx&workspace_id=xxx&code=D1F32GF6",
  "internet_share_link" : "https://127.0.0.1:9445/#/share-space?username=xxx&workspace_id=xxx&code=D1F32GF6",
  "create_time" : "2022-03-28T00:00:00Z",
  "status" : "OPEN",
  "failed_reason" : null
}

状态码

状态码

描述

200

正常

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 桌面

相关文档