ListImages - Simple Application Server - Alibaba Cloud Documentation Center

Queries the information about images in a region.

Operation description

You can query details about one or more images in a specified region, including the IDs, names, and types of the images.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
swas-open:ListImages	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the images. You can call the ListRegions operation to query the most recent region list.	cn-hangzhou
ImageIds	string	No	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**"]
ImageType	string	No	The type of the images. Valid values: system: OS images app: application images custom: custom images	system

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
Images	array<object>	The OS type of the image. Valid values: Linux Windows
Image	object
ImageType	string	The type of the image. Valid values: system app custom	app
Description	string	The description of the image.
ImageName	string	The name of the image.	WordPress-4.8.1
ImageId	string	The ID of the image.	794c230fd3e64ea19f83f4d7a0ad****
Platform	string	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 code	Error code	Error message
400	InvalidImageType.ValueNotSupported	The specified parameter ImageType is invalid.
403	InvalidParam	The specified parameter value is invalid.
500	InternalError	An error occurred while processing your request.

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

Change history

Change time	Summary of changes	Operation
2023-09-18	API Description Update. The Error code has changed	View Change Details