CreateImage - Elastic Desktop Service - Alibaba Cloud Documentation Center

Creates a custom image based on a deployed cloud computer. Then, you can use the custom image to create cloud computers that have the same configurations. This prevents the repeated settings when you create cloud computers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:CreateImage	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DesktopId	string	Yes	The ID of the cloud computer.	ecd-7w78ozhjcwa3u****
ImageName	string	No	The name of the image. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).	testImageName
Description	string	No	The description of the custom image. The description must be 2 to 256 characters in length. It cannot start with `http://` or `https://`.	This is description.
SnapshotId	string	No	The ID of the snapshot.	s-2zefuwk8l6ytcgd3bf4o
ImageResourceType	string	No	This parameter is not publicly available.	To be hidden.
SnapshotIds	array	No	The IDs of the snapshots.
	string	No	The ID of the snapshot.	[\"s-2ze2ai7op1duq4mnx5ha\"]
AutoCleanUserdata	boolean	No	Specifies whether to clear private data of users. If you set AutoCleanUserdata to `true`, the custom image clears the data directories, excluding the `Administrator` and `Public` directories, in the `C:\Users` directory.	false
DiskType	string	No	The disk data that is contained in the custom image. Valid values: SYSTEM: only contain data from system disks. ALL: contain data from system disks and user disks. [default]	ALL

Response parameters

Parameter	Type	Description	Example
	object
ImageId	string	The ID of the image.	m-gx2x1dhsmusr2****
RequestId	string	The ID of the request.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

{
  "ImageId": "m-gx2x1dhsmusr2****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-04-09	The request parameters of the API has changed	View Change Details
2023-06-13	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-06-22	The request parameters of the API has changed	View Change Details