DescribeImages - Developer Guide| Alibaba Cloud Documentation Center

Description

Query the list of available images.

The displayed image resource list contains your custom images, public images from Alibaba Cloud, and other available images from the image market.
If you need to create ECS instances using an image from the image market, you must subscribe the image beforehand.
You can query images by pages. The result consists of the total number of available image resources and all the image resources on the current page. By default, 10 images are displayed per page.

Request parameters

Name	Type	Required	Description
Action	String	Yes	Required parameter, with a value: DescribeImages.
RegionId	String	Yes	ID of the region to which an instance belongs.
ImageId	String	No	The image ID. Multiple image IDs can be entered, separated by single-byte commas.
SnapshotId	String	No	The ID of the snapshot used to create the image.
ImageName	String	No	The name of the image.
ImageOwnerAlias	string	No	The alias of the image owner. Value: system \| self \| others \| marketplace Default value: None, indicates that system + self + others is returned If this parameter is not specified, this parameter is not used as a filter condition. Value description: system: images provided by Alibaba Cloud self: images defined by users. others: available images of others. marketplace: images available on the image market.
PageNumber	Integer	No	Page number of the instance status list. The start value is 1. The default value is 1.
PageSize	Integer	No	Sets the number of lines per page for queries per page. The maximum value is 50. The default value is 10.

Return parameters

Name	Type	Description
RegionId	String	The region ID of the image.
TotalCount	Integer	The number of items on the list.
PageNumber	Integer	The current page.
PageSize	Integer	The number of items on the current page.
Images	ImageType	A collection composed of image information ImageType.

Error code

Error Code	Description	Http status code	Meaning
MissingParameter	The input parameter RegionId that is mandatory for processing this request is not supplied.	400	RegionId field missing.
InvalidImageOwnerAlias.ValueNotSupported	The specified ImageOwnerAlias value is not supported.	400	Invalid ImageOwnerAlias value.
InvalidParameter	The specified parameter PageNumber is not valid.	400	The specified PageNumber parameter is invalid.
InvalidParameter	The specified parameter PageSize is not valid.	400	The specified PageSize parameter is invalid.

Examples

Request example

https://ecs.aliyuncs.com/?Action=DescribeImages
&RegionId=cn-hangzhou
&<Public Request Parameters>

Return example

XML format

<DescribeImagesResponse>
    <Images>
        <Image>
            <Architecture>i386</Architecture>
            <CreationTime>2014-07-22T09:53:44Z</CreationTime>
            <Description></Description>
            <DiskDeviceMappings>
                <DiskDeviceMapping>
                    <Device>/dev/xvda</Device>
                    <Size>20</Size>
                    <SnapshotId></SnapshotId>
                </DiskDeviceMapping>
            </DiskDeviceMappings>
            <ImageId>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageId>
            <ImageName>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageName>
            <ImageOwnerAlias>system</ImageOwnerAlias>
            <ImageVersion>1.0</ImageVersion>
            <IsCopied>false</IsCopied>
            <IsSubscribed>false</IsSubscribed>
            <OSName>SUSE Linux  Enterprise Server 11 SP3 64bit</OSName>
            <ProductCode></ProductCode>
            <OSType>linux</OSType>
            <Platform>SUSE</Platform>
            <Progress>100</Progress>
            <Size>20</Size>
            <Status>Available</Status>
            <Usage>instance</Usage>
        </Image>
    </Images>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <RegionId>cn-hangzhou</RegionId>
    <TotalCount>24</TotalCount>
    <RequestId>7871BB26-3002-4950-B2E6-98D333077EA5</RequestId>
</DescribeImagesResponse>

JSON format

{
  "Images": {
    "Image": [
      {
        "Architecture": "x86_64",
        "CreationTime": "2015-05-06T09:01:32Z",
        "DiskDeviceMappings": {
          "DiskDeviceMapping": [
            {
              "Device": "/dev/xvda",
              "Size": "20"
            }
          ]
        },
        "ImageId": "suse11sp3_64_20G_aliaegis_20150428.vhd",
        "ImageName": "suse11sp3_64_20G_aliaegis_20150428.vhd",
        "ImageOwnerAlias": "system",
        "ImageVersion": "1",
        "IsCopied": false,
        "IsSubscribed": false,
        "OSName": "SUSE Linux  Enterprise Server 11 SP3 64bit",
        "OSType": "linux",
        "Platform": "SUSE",
        "Progress": "100%",
        "Size": 20,
        "Status": "Available",
        "Usage": "instance"
      }
    ]
  }
  "PageNumber": 1,
  "PageSize": 1,
  "RegionId": "cn-hangzhou",
  "RequestId": "49CBCED4-C9B9-4851-BEB5-8FB5E5169E30",
  "TotalCount": 24
}