Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Querying Desktop Connection Statuses

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

View PDF

Querying Desktop Connection Statuses

Function

Queries desktop connection statuses.

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:listWithConnectStatus	List	-	-	-	-

URI

GET /v2/{project_id}/connect-desktops

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
user_names	No	Array of strings	Desktop user. Up to 100 users can be filtered in batches.
connect_status	No	String	Desktop connection status. UNREGISTER: unregistered (a desktop is automatically registered after being started). After a desktop is shut down, it is in the unregistered status. REGISTERED: The desktop has been registered and can be logged in to. CONNECTED: The desktop has been logged in to and is being used. DISCONNECTED: The desktop is disconnected from the client because the client window is closed or the networking between the client and desktop is interrupted.
offset	No	Integer	Sequence number of the first data record to be returned. This parameter is used for pagination query. The value ranges from 0 (default) to 2,000.
limit	No	Integer	Number of data records to be returned in the query result. This parameter is used for pagination query. The value ranges from 0 to 2,000. The default value is 100.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
desktops	Array of ConnectDesktopsInfo objects	Desktop connection data list.
total_count	Integer	Total number of desktops.

**Table 4** ConnectDesktopsInfo
Parameter	Type	Description
desktop_id	String	Desktop ID.
desktop_name	String	Desktop name.
connect_status	String	Desktop connection status. UNREGISTER: unregistered (a desktop is automatically registered after being started). After a desktop is shut down, it is in the unregistered status. REGISTERED: The desktop has been registered and can be logged in to. CONNECTED: The desktop has been logged in to and is being used. DISCONNECTED: The desktop is disconnected from the client because the client window is closed or the networking between the client and desktop is interrupted.
attach_users	Array of AttachUsersInfo objects	List of users or user groups to which desktops have been assigned.

**Table 5** AttachUsersInfo
Parameter	Type	Description
id	String	If type is set to USER, enter the user ID. If type is set to GROUP, enter the user group ID. The backend service checks whether the group ID exists.
name	String	Name of the object assigned with a desktop. If type is set to USER, enter the username. If type is set to GROUP, enter the user group name. If type is set to USER, the value is the username of the desktop user. After the desktop is assigned, the user can log in to the desktop. Only letters, digits, hyphens (-), and underscores (_) are allowed. When the domain type is LITE_AD, the value contains 1 to 20 characters starting with a letter. When the domain type is LOCAL_AD, the value contains 1 to 64 characters starting with a letter or digit. A Windows desktop username can contain a maximum of 20 characters, and a Linux desktop username can contain a maximum of 64 characters. The backend service checks whether the username exists. The username cannot be the same as the desktop name. If type is set to GROUP, the value can contain only letters, digits, hyphens (-), and underscores (_).
user_group	String	User group to which the desktop user belongs. sudo: Linux administrator group default: default Linux user group administrators: Windows administrator group. Administrators have full access to the desktop and can make any required changes except for forbidden operations. users: standard Windows user group. Standard users can use most software programs and change system settings that do not affect other users.
type	String	Object type. Options: USER: user GROUP: user group

Status code: 400

**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: 401

**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.

Status code: 403

**Table 8** 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 9** 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 10** 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

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/connect-desktops

Example Responses

Status code: 200

Response to the request for querying cloud desktop details.

{
  "desktops" : [ {
    "desktop_id" : "string",
    "desktop_name" : "string",
    "connect_status" : "string",
    "attach_users" : [ {
      "id" : "string",
      "name" : "string",
      "user_group" : "string",
      "type" : "USER"
    } ]
  } ],
  "total_count" : 0
}

Status Codes

Status Code	Description
200	Response to the request for querying cloud desktop details.
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 about the error code, see the error code description.