CreateImage - ENS - Alibaba Cloud Documentation Center

Creates an image from an instance.

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
ens:CreateImage	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the instance.	i-5rr1bnyrc4tswr8cq3w6y****
ImageName	string	Yes	The name of the image. The name must be 2 to 128 characters in length. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-). It must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).	ImageName
DeleteAfterImageUpload	string	No	Specifies whether to automatically release the instance after the image is packaged and uploaded. Only image builders are supported. Default value: false. Valid values: true: The image is released when the instance is released. false: The image is retained when the instance is released. If you leave this property empty, false is used by default.	false
SnapshotId	string	No	The ID of the snapshot.	s-bp67acfmxazb4p****
TargetOSSRegionId	string	No	The region of the destination OSS bucket where the image is to be stored. Enumeration Value: cn-beijing ap-southeast-1	cn-beijing
WithDataDisks	boolean	No	Specifies whether to include data disk snapshots in the custom image.	Value true false (default)

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	8BEF0D72-9901-5D43-B7D3-8B42AC26C516
Code	integer	The returned service code. 0 indicates that the request was successful.	0
ImageId	string	The ID of the image.	m-5xxgg

Examples

Sample success responses

JSONformat

{
  "RequestId": "8BEF0D72-9901-5D43-B7D3-8B42AC26C516",
  "Code": 0,
  "ImageId": "m-5xxgg"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameters that is mandatory for processing this request is not supplied.	-
400	NoPermission	Permission denied.	-
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-
400	QuotaExceed	The custom image quota has been used up.	-

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

Change history

Change time	Summary of changes	Operation
2025-01-10	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-03-19	The Error code has changed	View Change Details
2023-03-03	The Error code has changed. The request parameters of the API has changed	View Change Details