Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Pools/ Listing Associated Desktop Pools

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

View PDF

Listing Associated Desktop Pools

Function

Lists desktop pools associated with a user.

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, no identity policy-based permission required for calling this API.

URI

GET /v2/{project_id}/desktop-pools/statistics/by-users

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
user_ids	No	Array of strings	List of user IDs to be queried.
offset	No	Integer	Where the pagination query starts. The value starts from 0.
limit	No	Integer	Limits the quantity of returned desktops in pagination query. The value ranges from 0 to 10. The default value is 10.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
users	Array of ShowDesktopPoolListByUsersInfo objects	User list.

**Table 4** ShowDesktopPoolListByUsersInfo
Parameter	Type	Description
user_id	String	User ID.
desktop_pool_count	Integer	Number of desktop pools.
desktop_pools	Array of AttachDesktopPoolsInfo objects	Running Status Statistics

**Table 5** AttachDesktopPoolsInfo
Parameter	Type	Description
desktop_pool_id	String	Desktop pool ID.
desktop_pool_name	String	Desktop pool name.
is_attached	Boolean	Whether a desktop is assigned.

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: 409

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

Status code: 500

**Table 11** 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/desktops-pools/statistics/by-users

Example Responses

Status code: 200

Lists desktop pools associated with a user.

{
  "users" : [ {
    "user_id" : "user_id",
    "desktop_pools" : [ {
      "desktop_pool_id" : "1ad74b36-0de7-45fe-aed3-6cb047d69e99",
      "desktop_pool_name" : "yay-test",
      "is_attached" : false
    } ]
  } ]
}

Status Codes

Status Code	Description
200	Lists desktop pools associated with a user.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
409	Operation conflict.
500	An internal service error occurred. For details about the error code, see the error code description.