Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Rebuild a Desktop

Updated on 2024-01-10 GMT+08:00

View PDF

Rebuild a Desktop

Function

Recomposes desktop system disks in batches.

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}/desktops/rebuild

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

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	No	String	MIME type of the request body.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
desktop_ids	Yes	Array of strings	Computer IDs.
image_type	Yes	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	Specifies the order ID, which is used to recompose the system disk of a yearly/monthly desktop. This parameter is mandatory when billed images are involved.
enterprise_project_id	No	String	Enterprise project ID. Its default value is 0.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error 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.

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.

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.

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.

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.

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.

Example Requests

{
  "desktop_ids" : [ "string" ],
  "image_type" : "string",
  "image_id" : "string",
  "os_type" : "string",
  "delay_time" : "integer",
  "message" : "string"
}

Example Responses

None

Status Codes

Status Code	Description
200	Normal.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
409	Operation conflict.
500	An internal service error occurred. For details, see the error code description.