All Products
Search
Document Center

Simple Application Server:ListImages

Last Updated:Apr 17, 2024

Queries the information about images in a region.

Operation description

You can query information about images in a region, including the IDs, names, and types of the images.

QPS limit

You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ImageIdsstringNo

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

["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]
ImageTypestringNo

The type of the images. Valid values:

  • system: OS images
  • app: application images
  • custom: custom images
system

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

20758A-585D-4A41-A9B2-28DA8F4F534F
Imagesobject []

The OS type of the image. Valid values:

  • Linux
  • Windows
ImageTypestring

The type of the image. Valid values:

  • system
  • app
  • custom
app
Descriptionstring

The description of the image.

ImageNamestring

The name of the image.

WordPress-4.8.1
ImageIdstring

The ID of the image.

794c230fd3e64ea19f83f4d7a0ad****
Platformstring

The operating system type of the image. Valid values:

  • Linux
  • Windows
Linux

Examples

Sample success responses

JSONformat

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "Images": [
    {
      "ImageType": "app",
      "Description": "",
      "ImageName": "WordPress-4.8.1",
      "ImageId": "794c230fd3e64ea19f83f4d7a0ad****",
      "Platform": "Linux"
    }
  ]
}

Error codes

HTTP status codeError codeError message
400InvalidImageType.ValueNotSupportedThe specified parameter ImageType is invalid.
403InvalidParamThe specified parameter value is invalid.
500InternalErrorAn error occurred while processing your request.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-18API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 500