Use the CreateImage API to create a custom image from a cloud computer - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Creates a custom image from a deployed cloud computer to quickly create more cloud computers with the same configuration, avoiding repeated configuration each time.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:CreateImage

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the regions supported by WUYING Workspace.	cn-hangzhou
DesktopId	string	No	The cloud computer ID.	ecd-7w78ozhjcwa3u****
ImageName	string	No	The image name. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter or a Chinese character and cannot start with `http://` or `https://`.	testImageName
Description	string	No	The description of the image. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.	This is description.
SnapshotId	string	No	The snapshot ID.	s-2zefuwk8l6ytcgd3bf4o
ImageResourceType	string	No	This parameter is not publicly available.	deprecated
SnapshotIds	array	No	The list of snapshot IDs.
	string	No	The snapshot ID.	[\"s-2ze2ai7op1duq4mnx5ha\"]
AutoCleanUserdata	boolean	No	Specifies whether to clear personal user data. If this parameter is set to `true`, the created image clears data in all directories under `C:\Users` except the `Administrator` and `Public` directories. Valid values: true : Clear personal user data. false : Do not clear personal user data. [Default]	false
DiskType	string	No	The disk data included in the image. Valid values: SYSTEM : Save only system cloud disk data. ALL : Save system cloud disk and data cloud disk data. [Default]	ALL
DataSnapshotIds	array	No	The list of data cloud disk snapshot IDs. To include data cloud disks when creating an image, specify the corresponding data cloud disk snapshot IDs. A maximum of 100 IDs are supported.	["s-bp67acfmxazb4ph**", "s-bp67acfmxazb5qh**"]
	string	No	The data cloud disk snapshot ID.	s-4kn5xu2j4d0z1r4x8

Response elements

Element	Type	Description	Example
	object	The response parameters.
ImageId	string	The image ID.	m-gx2x1dhsmusr2****
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	INSUFFICIENT_QUOTA	Insufficient quota.	The user quota is insufficient.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.