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

Updated on 2025-07-14 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.

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 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
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.
order_id	No	String	Order ID, which is used to recompose the system disk of a yearly/monthly-billed desktop. This parameter is mandatory when billed images are used.
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.

Response Parameters

Status code: 200

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

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

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

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

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

Example Requests

{
  "image_type" : "string",
  "image_id" : "string",
  "os_type" : "string",
  "delay_time" : 15,
  "message" : "string",
  "order_id" : "string",
  "is_fix" : false
}

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.