ImportImage

Description

When you call this operation, take note of the following items:

• You must upload an image to an Object Storage Service (OSS) bucket before you can import the image. For more information, see Upload objects.

• The first time you import an image, you must use Resource Access Management (RAM) to authorize ECS to access your OSS buckets. If ECS is not authorized to access your OSS buckets, the NoSetRoletoECSServiceAcount error code is returned when you call the ImportImage operation. For more information, see Account access control. The following examples show the policies required for some operations:

  1. Create a role named AliyunECSImageImportDefaultRole. You must use this exact name. Otherwise, the image cannot be imported. Configure the following trust policy for the role:

  
          {
              "Statement": [
              {
                  "Action": "sts:AssumeRole",
                  "Effect": "Allow",
                  "Principal": {
                  "Service": [
                      "ecs.aliyuncs.com"
                  ]
                  }
              }
          ],
              "Version": "1"
          }
          

  2. Attach the AliyunECSImageImportRolePolicy system policy to the role. For more information, visit the Cloud Resource Access Authorization page of the RAM console. You can also create a custom policy that contains the following content and attach the policy to the role:

  
          {
              "Version": "1",
              "Statement": [
              {
                  "Action": [
                          "oss:GetObject",
                          "oss:GetBucketLocation",
                          "oss:GetBucketInfo"
              ],
                      "Resource": "*",
                      "Effect": "Allow"
                      }
              ]
          }
          

• You cannot delete an image that is being imported. However, you can call the CancelTask operation to cancel the image import task.
• You can import an image only to the same region as the OSS bucket to which the image is uploaded.
• The valid values of N in the DiskDeviceMapping.N parameter ranges from 1 to 17. When N is set to 1, the disk is a system disk. When N is set to a value from 2 to 17, the disk is a data disk.
• When the Architecture parameter is set to arm64, or when the Platform parameter is set to Anolis, take note of the following items:
  • To ensure that the password can be set or the key pair can be modified for the imported image, the image must meet the following requirements:
    • The kernel of the operating system must support the CONFIG_FW_CFG_SYSFS feature. By default, the Linux community kernel 4.6 and later and CentOS kernel 3.10.0-826.el7 and later must support this feature. You can run the grep -nr CONFIG_FW_CFG_SYSFS /boot/config-$(uname -r) command in the server corresponding to the image. If the command output contains CONFIG_FW_CFG_SYSFS=y, the kernel of this image supports the CONFIG_FW_CFG_SYSFS feature.
    • The operating system must have the latest version of Alibaba Cloud cloud-init installed. The version of cloud-init 19.1 must be 19.1.3 or later. The version of cloud-init 0.7.6a in some early versions of operating systems must be 0.7.6a15 or later. For more information, see Install cloud-init.
    • The operating system must support the SHA-512 encryption algorithm.
  • To ensure that the imported image supports resizing of disks and file systems, the image must meet the following requirements:
    • The kernel version of the operating system must be later than 3.6.
    • The image must support the growpart command. To support this command, you must install the cloud-utils-growpart package. The methods of installing the package vary based on the operating systems. For more information, see Resize partitions and file systems of Linux system disks.
    • The image must support the resize2fs command. To support this command, you must install the e2fsprogs package. The package is pre-installed in the operating system by default. If the package is not installed, install it on your own.
    • The operating system is installed with the latest version of Alibaba Cloud cloud-init. The version of cloud-init 19.1 must be 19.1.3 or later. The version of cloud-init 0.7.6a in some early versions of operating systems must be 0.7.6a15 or later. For more information, see Install cloud-init.

Request parameters

Response parameters

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=ImportImage
&RegionId=cn-hangzhou
&DiskDeviceMapping.1.Format=QCOW2
&DiskDeviceMapping.1.OSSBucket=ecsimageos
&DiskDeviceMapping.1.OSSObject=CentOS_5.4_32.raw
&DiskDeviceMapping.1.DiskImageSize=80
&ImageName=Test
&Description=Test
&Architecture=x86_64
&OSType=linux
&Platform=Aliyun
&LicenseType=Aliyun
&<Common request parameters>

Sample success responses

XML format

<ImportImageResponse>
      <RequestId>C8B26B44-0189-443E-9816-D951F59623A9</RequestId>
      <ImageId>m-bp67acfmxazb4p****</ImageId>
      <RegionId>cn-hangzhou</RegionId>
      <ImportTaskId>t-bp67acfmxazb4p****</ImportTaskId>
</ImportImageResponse>

JSON format

{
    "RequestId": "C8B26B44-0189-443E-9816-D951F59623A9",
    "ImageId": "m-bp67acfmxazb4p****",
    "RegionId": "cn-hangzhou",
    "ImportTaskId": "t-bp67acfmxazb4p****"
}

Error codes

For a list of error codes, visit the API Error Center.