Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Querying Desktop Unbinding Information

Updated on 2026-02-10 GMT+08:00

View PDF

Querying Desktop Unbinding Information

Function

Queries desktop unbinding information.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:desktops:listDetachInfo	List	desktop *	-	-	-
workspace:desktops:listDetachInfo	List	-	g:RequestTag/<tag-key> g:TagKeys g:EnterpriseProjectId	-	-

URI

GET /v2/{project_id}/desktops/{desktop_id}/detach-info

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

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
desktop_detach_infos	Array of DesktopDetachInfo objects	Desktop unbinding information.

**Table 3** DesktopDetachInfo
Parameter	Type	Description
desktop_id	String	Desktop ID.
desktop_name	String	Desktop name.
user_id	String	User ID.
user_name	String	Username.
user_group	String	User permissions.
detach_time	String	Unbinding time.
type	String	Object type. Options: USER: user GROUP: user group

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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

None

Example Responses

Status code: 200

Response to the request for querying desktop unbinding information.

{
  "desktop_detach_infos" : [ {
    "desktop_id" : "string",
    "desktop_name" : "string",
    "user_id" : "string",
    "user_name" : "string",
    "user_group" : "string",
    "detach_time" : "string",
    "type" : "USER"
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for querying desktop unbinding information.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	An internal service error occurred. For details about the error code, see the error code description.