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

Create a custom image from an existing WUYING Workspace. Use this image to quickly deploy more workspaces with identical configurations. Avoid repeating configuration steps each time you create a new workspace.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Call DescribeRegions to view the list of regions that support WUYING Workspace.	cn-hangzhou
DesktopId	string	No	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. It must start with a letter or Chinese character. It cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).	testImageName
Description	string	No	The description of the 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 available for use.	deprecated
SnapshotIds	array	No	A list of snapshot IDs.
	string	No	A snapshot ID.	[\"s-2ze2ai7op1duq4mnx5ha\"]
AutoCleanUserdata	boolean	No	Specify whether to clear user personal data. If set to `true`, the image clears all folders under `C:\Users`, except `Administrator` and `Public`. Valid values: true : Clear user personal data false : Do not clear user personal data [default]	false
DiskType	string	No	The disk data included in the image. Valid values: SYSTEM : Save only system disk data ALL : Save system disk and data disk data [default]	ALL
DataSnapshotIds	array	No
	string	No

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.