Queries the details of one or more images in a specified region.
Description
You can query details about one or more images in a specified region, including the IDs, names, and types of the images.
QPS limits
The queries per second (QPS) limit for a single user for the API operation is 10 calls per minute. If the number of your calls per second exceeds the limit, throttling is triggered. This may affect your business. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit.
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 images. You can call the ListRegions operation to query the most recent region list. |
ImageIds | String | No | ["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"] |
The IDs of the images. The value can be a JSON array that consists of up to 50 image
IDs, in the format of |
ImageType | String | No | system |
The type of the image. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 20758A-585D-4A41-A9B2-28DA8F4F534F |
The ID of the request. |
Images | Array of Image |
Details of the images. |
|
ImageType | String | app |
The type of the image. Valid values:
|
Description | String | WordPress is a platform that allows you to build blogs and content management websites and implement custom 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. |
ImageName | String | WordPress-4.8.1 |
The name of the image. |
ImageId | String | 794c230fd3e64ea19f83f4d7a0ad**** |
The ID of the image. |
Platform | String | Linux |
The operating system type of the image. Valid values:
|
Examples
Sample requests
https://swas.cn-hangzhou.aliyuncs.com/?Action=ListImages
&ImageIds=["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ListImagesResponse>
<RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>
<Images>
<ImageType>app</ImageType>
<Description>WordPress is a platform that allows you to build blogs and content management websites and implement custom features by using third-party templates and plug-ins. The image is based on the CentOS 7.3 64-bit operating system. </Description>
<ImageName>WordPress-4.8.1</ImageName>
<ImageId>794c230fd3e64ea19f83f4d7a0ad****</ImageId>
<Platform>Linux</Platform>
</Images>
</ListImagesResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "20758A-585D-4A41-A9B2-28DA8F4F534F",
"Images" : {
"ImageType" : "app",
"Description" : "WordPress is a platform that allows you to build blogs and content management websites and implement custom features by using third-party templates and plug-ins. The image is based on the CentOS 7.3 64-bit operating system.",
"ImageName" : "WordPress-4.8.1",
"ImageId" : "794c230fd3e64ea19f83f4d7a0ad****",
"Platform" : "Linux"
}
}
Error codes
HttpCode | 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. |
403 | InvalidParam | The specified parameter value is invalid. | The error message returned because a specified 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 problem persists, submit a ticket. |
For a list of error codes, visit the API Error Center.