Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Querying Remote Assistance Data by Desktop ID

Updated on 2025-07-14 GMT+08:00

View PDF

Querying Remote Assistance Data by Desktop ID

Function

Queries remote assistance data by desktop ID.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
desktop_id	Yes	String	Desktop ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	No	String	MIME type of the request body.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
share_space_id	String	Collaborative space ID.
invitation_code	String	Collaborative space invitation code (eight characters consisting of uppercase letters and digits).
share_space_name	String	Collaborative space name.
share_space_passwd	String	Collaborative space password.
private_share_link	String	Shared Direct Connect link.
internet_share_link	String	Shared Internet access link.
create_time	String	Creation time (UTC time, yyyy-MM-dd'T'HH:mm:ss'Z).'
status	String	Collaborative space status. OPEN: The collaborative space has been created. CLOSE: The collaborative space has been closed. WAIT_USER_CONFIRM: waiting for the user to confirm remote assistance WAIT_USER_ACCESS: waiting for the user to enable remote assistance
failed_reason	String	Failure cause.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

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

Example Responses

Status code: 200

Normal.

{
  "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
}

Status Codes

Status Code	Description
200	Normal.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	An internal service error occurred. For details, see the error code description.