Queries the details of one or more images within a specified region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListImages

The operation that you want to perform. Set the value to ListImages.

RegionId String Yes cn-hangzhou

The region ID of the image. You can call the ListRegions operation to query the most recent region list.

ImageIds String No ["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]

The IDs of images. The value can be a JSON array that consists of up to 50 image IDs, in the format of ["xxx", "yyy", … "zzz"]. Separate the image IDs with commas (,).

ImageType String No system

The type of the image. Valid values:

  • system: operating system (OS) image
  • app: application image
  • custom: custom image

Response parameters

Parameter Type Example Description
Images Array of Image

Details of the images.

Description String WordPress is the most popular and powerful platform that allows you to build blogs and content management websites and customize features by using third-party templates and plug-ins. The image is based on the CentOS 7.3 64-bit operating system.

The description of the image.

ImageId String 794c230fd3e64ea19f83f4d7a0ad****

The ID of the image.

ImageName String WordPress-4.8.1

The name of the image.

ImageType String app

The type of the image. Valid values:

  • system: OS image
  • app: application image
  • custom: custom image
RequestId String 20758A-585D-4A41-A9B2-28DA8F4F534F

The ID of the request.

Examples

Sample requests

https://swas.cn-hangzhou.aliyuncs.com/?Action=ListImages
&ImageIds=["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]
&<Common request parameters>

Sample success responses

XML format

<ListImagesResponse>
      <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>
      <Images>
            <ImageName>WordPress-4.8.1</ImageName>
            <Description>WordPress is the most popular that powerful platform and allows you to build blogs and content management websites and customize features by using third-party templates and plug-ins. The image is based on the CentOS 7.3 64-bit operating system. </Description>
            <ImageId>794c230fd3e64ea19f83f4d7a0ad****</ImageId>
            <ImageType>app</ImageType>
      </Images>
      <Images>
            <ImageName>CentOS-7.3</ImageName>
            <Description>CentOS is an enterprise Linux distribution based on the freely available sources from Red Hat Linux.</Description>
            <ImageId>fe9c66133a9d4688872869726b52****</ImageId>
            <ImageType>system</ImageType>
      </Images>
</ListImagesResponse>

JSON format

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "Images": [
    {
      "ImageName": "WordPress-4.8.1",
      "Description": "WordPress is the most popular and powerful platform that allows you to build blogs and content management websites and customize features by using third-party templates and plug-ins. The image is based on the CentOS 7.3 64-bit operating system.",
      "ImageId": "794c230fd3e64ea19f83f4d7a0ad****",
      "ImageType": "app"
    },
    {
      "ImageName": "CentOS-7.3",
      "Description": "CentOS is an enterprise Linux distribution based on the freely available sources from Red Hat Linux.",
      "ImageId": "fe9c66133a9d4688872869726b52****",
      "ImageType": "system"
    }
  ]
}

Error codes

HTTP status code Error code Error message Description
400 InvalidImageType.ValueNotSupported The specified parameter ImageType is invalid. The error message returned because the specified ImageType parameter is invalid.
500 InternalError An error occurred while processing your request. The error message returned because an internal error has occurred. Try again later. If the error persists, submit a ticket.
403 InvalidParam The specified parameter value is invalid. The error message returned because a specified parameter is invalid.

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