Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Pools/ Change desktop pool specifications

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

View PDF

Change desktop pool specifications

Modifies desktop pool specifications.

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

POST /v2/{project_id}/desktop-pools/{pool_id}/resize

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
pool_id	Yes	String	Specifies the desktop pool ID.

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
product_id	Yes	String	Specifies the product ID of the target specifications.
flavor_id	No	String	Product specification ID. This parameter is mandatory when the AZ is an edge AZ.
mode	No	String	Whether specifications can be modified when the desktop is started. The value is fixed to STOP_DESKTOP. If the desktop has been started, the desktop will be stopped before the specifications are modified.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	ID of the cloud desktop creation task.
jobs	Array of ResizeDesktopPoolJobResponse objects	Task information returned after the specifications of on-demand desktops are changed.

**Table 5** ResizeDesktopPoolJobResponse
Parameter	Type	Description
desktop_id	String	Desktop ID.
job_id	String	Task ID.

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

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

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

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

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

{
  "product_id" : "workspace.x86.ultimate.xlarge2"
}

Status code: 200

Normal.

{
  "job_id" : "abc85365-0b2e-4b4f-a091-f7db72072d4b"
}

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.
409	Operation conflict.
500	An internal service error occurred. For details about the error code, see the error code description.