Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Pools/ Recompose the system disk in the desktop pool

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

View PDF

Recompose the system disk in the desktop pool

Function

Recompose the system disk of a desktop pool.

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:desktopPools:rebuild	Write	desktopPool *	-	-	vpc:ports:get ims:images:get ims:images:list ims:images:share ims:images:updateMemberStatus ims:images:deleteMember ims:images:addMember

URI

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

**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 body parameters
Parameter	Mandatory	Type	Description
image_type	No	String	Image type.
image_id	Yes	String	Template ID.
os_type	No	String	OS type.
delay_time	No	Integer	Time reserved for users to save data during immediate recomposing (unit: minute).
message	No	String	Message sent to a user when a system disk recomposing task is delivered.
is_fix	No	Boolean	Indicates whether to repair desktops whose image IDs are different from those in the desktop pool. This parameter is used to repair desktops whose image IDs are different from those in the desktop pool when the desktop pool fails to switch images.
handle_type	No	String	Processing type. ONLY_FOR_EXPAND: only added desktops FOR_EXPAND_AND_IDLE: added and idle desktops FOR_EXPAND_AND_ALL: added and existing desktops
encrypt_type	No	String	Encryption type. KEEP: original encryption state retained UNENCRYPTED: not encrypted ENCRYPTED: encrypted (kms_id needs to be uploaded at the same time)
kms_id	No	String	Key ID. This parameter is mandatory when encrypt_type is set to ENCRYPTED.
desktop_ids	No	Array of strings	Desktop ID.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
job_id	String	Specifies the ID of the general task for recomposing the system disk.

Status code: 400

**Table 4** 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 5** 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 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: 404

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

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

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

Example Requests

POST /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops-pools/a130ab3a-72bf-4b71-baa9-af4987c8e338/rebuild

{
  "delay_time" : 0,
  "message" : "rebuild",
  "image_type" : "gold",
  "os_type" : "Windows",
  "image_id" : "a9ed8b45-c259-4959-9b26-5d886dad807f"
}

Example Responses

Status code: 200

Normal.

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

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