Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Converting a Desktop to an Image

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

View PDF

Converting a Desktop to an Image

Function

Converts a desktop to an image.

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/desktop-to-image

**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	No	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
image_name	Yes	String	Image name.
image_description	No	String	Image description.
desktop_id	Yes	String	Instance ID of the desktop used to create an image.
execute_sysprep	No	Boolean	Whether to perform system encapsulation.
image_tags	No	Array of TagKeyValue objects	Image tags.
enterprise_project_id	No	String	The enterprise project to which the image belongs. If the value is 0 or left blank, the image belongs to the default enterprise project. If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.
max_ram	No	String	Maximum memory size (MB) allowed by the image.
min_ram	No	String	Minimum memory size (MB) allowed by the image. The default value is 0, indicating that the memory size is not restricted.

**Table 4** TagKeyValue
Parameter	Mandatory	Type	Description
key	No	String	Tag key.
value	No	String	Tag value.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
job_id	String	ID of the desktop-to-image conversion task.

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.

Example Requests

{
  "image_name" : "string",
  "image_description" : "string",
  "desktop_id" : "string",
  "execute_sysprep" : "true",
  "image_tags" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "enterprise_project_id" : "string",
  "max_ram" : "string",
  "min_ram" : "string"
}

Example Responses

Status code: 200

Response to the request for converting a desktop to an image.

{
  "job_id" : "string"
}

Status Codes

Status Code	Description
200	Response to the request for converting a desktop to an image.
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, see the error code description.