CreateImage

Description

Creates a custom image. When you call this interface, consider the following:

• You can use a custom image only after its status becomes Available.

• You can use a custom image to create an ECS instance or change the system disk for an existing instance.

• If you create a custom image based on an instance, once the specified instance is locked, the OperationLocks of the instance cannot indicate "LockReason" : "security".

Three approaches of creating a custom image are as follows:

Approach 1. If you want to create a custom image based on the system disk of your ECS instance, you can specify one of the system disk snapshots (SnapshotId) to create a custom image. However, the specified SnapshotId cannot be created on or earlier than July 15, 2013.

Approach 2. If you want to create a template for a whole ECS instance, you can specify the InstanceId to create a custom image. You must make sure that the status of the specified instance is Running or Stopped. After a successful invocation, each disk of the specified instance has a new snapshot created.

Approach 3. If you want to combine multiple snapshots to make an image template, you can specify DiskDeviceMappings to create a custom image. When you specify DiskDeviceMappings, consider the following:

• You can only specify one system disk snapshot. The device name of the system disk must be /dev/xvda.
• You can specify multiple data disk snapshots. The device names of the data disks are allocated sequentially from /dev/xvdb to /dev/xvdz, without duplicates.
• SnapshotId is not required, if you do not specify the SnapshotId, a disk with empty size is created.
• However, the specified SnapshotId cannot be created on or earlier than July 15, 2013.

Request parameters

Response parameters

Examples

Request example

https://ecs.aliyuncs.com/?Action=CreateImage
&RegionId=cn-hangzhou
&SnapshotId=s-snapshot1
&ImageName=demo_image
&<Common Request Parameters>

Response example

XML format

<CreateImageResponse>
    <RequestId>C8B26B44-0189-443E-9816-D951F59623A9</RequestId>
    <ImageId>m-63DFD5FB2</ImageId>
</CreateImageResponse>

JSON format

{
    "RequestId": "C8B26B44-0189-443E-9816-D951F59623A9",
    "ImageId": "m-63DFD5FB2"
}

Error codes