Elastic Compute Service:DescribeImages

Usage notes

• You can query your custom images, public images provided by Alibaba Cloud, Alibaba Cloud Marketplace images, and shared images from other Alibaba Cloud accounts.
• This operation supports paged query. The response contains the total number of available images and the number of images on the returned page. By default, 10 entries are displayed on each page.
• When you call an API operation by using Alibaba Cloud CLI, you must specify request parameter values of different data types in the required formats. For more information, see Parameter format overview.
• If you set ImageOwnerAlias to system or others in the DescribeImages operation to query images that are provided by Alibaba Cloud or shared images, Resource Access Management (RAM) authentication rules are ignored in the operation. For more information, see Authentication rules.

Request parameters

Response parameters

Examples

Sample requests

http(s)://ecs.aliyuncs.com/?Action=DescribeImages
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=1
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeImagesResponse>
    <TotalCount>1</TotalCount>
    <PageSize>1</PageSize>
    <RequestId>66189103-EDB2-43E2-BB60-BFF2B62F4EB8</RequestId>
    <PageNumber>1</PageNumber>
    <Images>
        <Image>
            <ImageOwnerAlias>self</ImageOwnerAlias>
            <IsSelfShared>true</IsSelfShared>
            <Description>Archive log for Oracle</Description>
            <Platform>Windows Server 2016</Platform>
            <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
            <Size>60</Size>
            <IsSubscribed>false</IsSubscribed>
            <BootMode>BIOS</BootMode>
            <OSName>Windows Server 2016 Datacenter 64-bit (Simplified Chinese)</OSName>
            <IsPublic>false</IsPublic>
            <ImageId>m-bp1g7004ksh0oeuc****</ImageId>
            <DetectionOptions/>
            <Features>
                <NvmeSupport>supported</NvmeSupport>
            </Features>
            <OSNameEn>Windows Server 2016 Data Center Edition 64bit Chinese Edition</OSNameEn>
            <Tags>
                <Tag>
                    <TagKey>DTS</TagKey>
                    <TagValue>Oracle</TagValue>
                </Tag>
            </Tags>
            <LoginAsNonRootSupported>false</LoginAsNonRootSupported>
            <Status>Available</Status>
            <Progress>100%</Progress>
            <Usage>none</Usage>
            <Architecture>x86_64</Architecture>
            <ProductCode>test000****</ProductCode>
            <IsCopied>false</IsCopied>
            <ImageFamily>hangzhou-daily-update</ImageFamily>
            <IsSupportIoOptimized>true</IsSupportIoOptimized>
            <IsSupportCloudinit>true</IsSupportCloudinit>
            <ImageName>testImageName</ImageName>
            <DiskDeviceMappings>
                <DiskDeviceMapping>
                    <SnapshotId>s-bp17ot2q7x72ggtw****</SnapshotId>
                    <Type>system</Type>
                    <Progress>32%</Progress>
                    <Format>qcow2</Format>
                    <Device>/dev/xvda</Device>
                    <Size>60</Size>
                    <ImportOSSBucket>testEcsImport</ImportOSSBucket>
                    <ImportOSSObject>imageImport</ImportOSSObject>
                </DiskDeviceMapping>
            </DiskDeviceMappings>
            <ImageVersion>2</ImageVersion>
            <OSType>windows</OSType>
            <CreationTime>2019-11-15T06:07:05Z</CreationTime>
        </Image>
    </Images>
    <RegionId>cn-hangzhou</RegionId>
</DescribeImagesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 1,
  "RequestId" : "66189103-EDB2-43E2-BB60-BFF2B62F4EB8",
  "PageNumber" : 1,
  "Images" : {
    "Image" : [ {
      "ImageOwnerAlias" : "self",
      "IsSelfShared" : "true",
      "Description" : "Archive log for Oracle",
      "Platform" : "Windows Server 2016",
      "ResourceGroupId" : "rg-bp67acfmxazb4p****",
      "Size" : 60,
      "IsSubscribed" : false,
      "BootMode" : "BIOS",
      "OSName": "Windows Server 2016 Datacenter 64-bit (Simplified Chinese)",
      "IsPublic" : false,
      "ImageId" : "m-bp1g7004ksh0oeuc****",
      "DetectionOptions" : { },
      "Features" : {
        "NvmeSupport" : "supported"
      },
      "OSNameEn" : "Windows Server 2016 Data Center Edition 64bit Chinese Edition",
      "Tags" : {
        "Tag" : [ {
          "TagKey" : "DTS",
          "TagValue" : "Oracle"
        } ]
      },
      "LoginAsNonRootSupported" : false,
      "Status" : "Available",
      "Progress" : "100%",
      "Usage" : "none",
      "Architecture" : "x86_64",
      "ProductCode" : "test000****",
      "IsCopied" : false,
      "ImageFamily" : "hangzhou-daily-update",
      "IsSupportIoOptimized" : true,
      "IsSupportCloudinit" : true,
      "ImageName" : "testImageName",
      "DiskDeviceMappings" : {
        "DiskDeviceMapping" : [ {
          "SnapshotId" : "s-bp17ot2q7x72ggtw****",
          "Type" : "system",
          "Progress" : "32%",
          "Format" : "qcow2",
          "Device" : "/dev/xvda",
          "Size" : "60",
          "ImportOSSBucket" : "testEcsImport",
          "ImportOSSObject" : "imageImport"
        } ]
      },
      "ImageVersion" : "2",
      "OSType" : "windows",
      "CreationTime" : "2019-11-15T06:07:05Z"
    } ]
  },
  "RegionId" : "cn-hangzhou"
}

Error codes

For a list of error codes, see Service error codes.