Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Modifies specifications

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

View PDF

Modifies specifications

Function

Only the CPU and memory can be modified. The disks cannot be changed, and the specifications can only be changed to different ones.

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:resize	Write	desktop *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	vpc:subnets:get ims:images:list

URI

POST /v2/{project_id}/desktops/resize

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

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
desktops	Yes	Array of ResizeDesktopData objects	Desktop data. You can change the specifications of desktops to the same specifications in batches.
product_id	Yes	String	Package ID. For a batch operation, VMs of the same specifications are used.
mode	Yes	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.
auto_placement	No	String	Whether to enable automatic placement. This parameter is used when the specifications of a DeH desktop are changed. The default value is off (disabled). You can change the value to on to enable automatic placement.
desktop_pool_id	No	String	Desktop pool ID.

**Table 3** ResizeDesktopData
Parameter	Mandatory	Type	Description
desktop_id	No	String	Desktop ID.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
jobs	Array of ResizeDesktopJobResponse objects	Task information returned when the desktop specifications are changed. (The jobs field will be deprecated. Use the job_id field instead.)
job_id	String	Specifies the ID of the specification modification task.

**Table 5** ResizeDesktopJobResponse
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 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

POST /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/resize

{
  "desktops" : [ {
    "desktop_id" : "538946c2-7ff8-4444-b1bd-e9a1f8137b81"
  } ],
  "product_id" : "workspace.k.xlarge.2.linux",
  "mode" : "STOP_DESKTOP"
}

Example Responses

Status code: 200

Response to the request for modifying specifications.

{
  "job_id" : "c566b960-69d1-44ec-9397-2172fdd01xxx",
  "jobs" : [ {
    "desktop_id" : "c566b960-69d1-44ec-9397-2172fdd015d9",
    "job_id" : "41162624-ba52-42f3-bdda-15c6d345ff60"
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for modifying specifications.
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.