On this page

Function
Debugging
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Pools/ Querying Desktop Pool Details

Querying Desktop Pool Details

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

View PDF

Function

Query details about a specified desktop pool by 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}/desktop-pools/{pool_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
pool_id	Yes	String	Specifies the desktop pool 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 used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Specifies the desktop pool ID.
name	String	Desktop pool name.
type	String	Desktop pool type. DYNAMIC: dynamic pool; STATIC: static pool.
description	String	Desktop pool description.
created_time	String	Specifies the creation time in UTC format, for example, 2022-05-11T11:45:42.000Z.
charging_mode	String	Specifies the billing mode. The value can be 0 (monthly) or 1 (pay-per-use).
desktop_count	Integer	Total number of desktops in the desktop pool.
desktop_used	Integer	Number of desktops bound to users in the desktop pool.
availability_zone	String	AZ.
subnet_id	String	Subnet ID.
product	ProductInfo object	Product information.
image_id	String	Image ID.
image_name	String	Image name.
image_os_type	String	Specifies the image OS type.
image_os_version	String	Specifies the image OS version.
image_os_platform	String	Image OS platform.
image_product_code	String	productCode (specCode) of an image.
root_volume	VolumeInfo object	System disk.
data_volumes	Array of VolumeInfo objects	Data disks.
security_groups	Array of SecurityGroupInfo objects	Desktop security group.
disconnected_retention_period	Integer	Number of minutes within which the binding relationship between a user and a desktop is retained when the dynamic pool desktop is disconnected. After the binding relationship times out, the user is automatically unbound.
enable_autoscale	Boolean	Specifies whether to enable auto scaling for the desktop pool. The value false indicates that auto scaling is disabled, and the value true indicates that auto scaling is enabled.
autoscale_policy	AutoscalePolicy object	Auto scaling policy.
status	String	Desktop pool status. STEADY: Steady TEMPORARY: Temporary EXIST_FROZEN: Frozen desktops exist. UNKNOWN: Unknown status
enterprise_project_id	String	Enterprise project ID.
in_maintenance_mode	Boolean	Whether a desktop pool is in administrator maintenance mode.
desktop_name_policy_id	String	Policy ID, which is used to specify the desktop name generation policy.

**Table 4** ProductInfo
Parameter	Type	Description
product_id	String	Product ID.
flavor_id	String	Specifications ID.
type	String	Product type. BASE: basic product package. OS is the only commercial software product in the package. Only this type of package can be used for private images.
cpu	String	CPU.
memory	String	Memory.
descriptions	String	Product description.
charge_mode	String	Billing type of the package. 1 indicates yearly/monthly billing, and 0 indicates pay-per-use billing.
architecture	String	Product architecture.
is_gpu	Boolean	Whether the specifications are of the GPU type.
package_type	String	Package type. ultimate: ultimate edition enterprise: enterprise edition general: general office edition workstation: cloud workstation edition dedicated: dedicated edition solver: solver edition agile: agile office edition
system_disk_type	String	System disk type.
system_disk_size	String	System disk size.
contain_data_disk	Boolean	Whether data disks are included in the package billing. off indicates no.
resource_type	String	Resource type.
cloud_service_type	String	Cloud service type.
volume_product_type	String	Disk type.
status	String	The status can be normal (by default, on sale), sellout (sold out), and abandon (unavailable).

**Table 5** VolumeInfo
Parameter	Type	Description
id	String	Specifies the IDs of the disks to be operated in batches.
type	String	Desktop data disk type, which must be the same as the disk type provided by the system. SAS: High I/O; SSD: Ultra-high I/O
size	Integer	Disk capacity in GB.
resource_spec_code	String	Specifications.

**Table 6** SecurityGroupInfo
Parameter	Type	Description
id	String	Security group ID.
name	String	Security group name.

**Table 7** AutoscalePolicy
Parameter	Type	Description
autoscale_type	String	Auto scaling type. The options are as follows: ACCESS_CREATED: created during access; AUTO_CREATED: auto scaling.
max_auto_created	Integer	Maximum number of desktops that can be automatically created.
min_idle	Integer	When the number of idle desktops is less than the value of this parameter, desktops are automatically created.
once_auto_created	Integer	Number of desktops that can be automatically created at a time.

Status code: 400

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

Status code: 401

**Table 9** 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 10** 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 11** 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 12** 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-pools/a130ab3a-72bf-4b71-baa9-af4987c8e338

Example Responses

Status code: 200

Normal.

{
  "id" : "1ad74b36-0de7-45fe-aed3-6cb047d69e99",
  "name" : "yay-test",
  "type" : "STATIC",
  "description" : "",
  "created_time" : "2025-05-22T09:48:47Z",
  "charging_mode" : "1",
  "desktop_count" : 10,
  "desktop_used" : 0,
  "availability_zone" : "cn-north-7c",
  "subnet_id" : "c7f30df4-f3ac-4807-9599-18950b05455f",
  "product" : {
    "product_id" : "workspace.x86.ultimate.large2",
    "flavor_id" : "c7.large.2",
    "type" : "BASE",
    "cpu" : "2",
    "memory" : "4096",
    "descriptions" : "Ultimate | 2 vCPUs | 4 GB memory",
    "charge_mode" : "1",
    "architecture" : "x86",
    "package_type" : "ultimate",
    "system_disk_type" : "SAS",
    "system_disk_size" : "140",
    "contain_data_disk" : false,
    "resource_type" : "hws.resource.type.workspace.desktop",
    "cloud_service_type" : "hws.service.type.vdi",
    "volume_product_type" : "workspace",
    "status" : "normal"
  },
  "image_id" : "cc3bbc0b-9441-461b-b80b-48c52f3aed08",
  "image_name" : "WKS_WIN1064_UserImage",
  "image_os_type" : "Windows",
  "image_os_version" : "Windows 10 64bit",
  "image_os_platform" : "Windows",
  "root_volume" : {
    "id" : "651d3724-fa85-420a-ab5f-ff531629747f",
    "type" : "SAS",
    "size" : 80
  },
  "data_volumes" : [ {
    "id" : "305d3c76-199f-4407-8d82-2a42d970595e",
    "type" : "SAS",
    "size" : 10
  }, {
    "id" : "9969022b-557d-4c1e-b22f-e7736ebe30af",
    "type" : "SAS",
    "size" : 10
  } ],
  "security_groups" : [ ],
  "disconnected_retention_period" : 0,
  "enable_autoscale" : true,
  "autoscale_policy" : {
    "autoscale_type" : "AUTO_CREATED",
    "max_auto_created" : 1,
    "min_idle" : 10,
    "once_auto_created" : 1
  },
  "status" : "STEADY",
  "enterprise_project_id" : "0",
  "in_maintenance_mode" : false
}

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 about the error code, see the error code description.