Use CreateImage to create an image from an instance - ENS

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

ens:CreateImage

create

*All Resource

*

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 long. It must start with a letter or a Chinese character and cannot start with `http://` or `https://`. It can contain digits, colons (:), underscores (_), and hyphens (-).	ImageName
DeleteAfterImageUpload	string	No	Specifies whether to automatically release the instance after the image is created and uploaded. This parameter applies only to build instances. `true`: The instance is automatically released after the image is created and uploaded. `false`: The instance is not released after the image is created and uploaded. Default value: `false`.	false
SnapshotId	string	No	The ID of the snapshot.	s-bp67acfmxazb4p****
TargetOSSRegionId	string	No	The ID of the target Region where the image will be stored in Object Storage Service (OSS).	cn-beijing
WithDataDisks	boolean	No	Specifies whether to include the data disks of the instance when creating the image.	true: with disk false: default. No disk

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	8BEF0D72-9901-5D43-B7D3-8B42AC26C516
Code	integer	The return code. A value of 0 indicates success.	0
ImageId	string	The ID of the created image.	m-5xxgg

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.