ListImages - Simple Application Server - Alibaba Cloud Documentation Center

Operation description

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

swas-open:ListImages

get

*All Resource

*

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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
Images	array<object>	Details of the queried images.
	object	The information about the image.
ImageType	string	The type of the image. Valid values: system app custom	app
Description	string	The description of the image.	WordPress是目前非常流行、强大的博客和内容管理网站的工具平台，借助第三方开发的模板、插件，用户可实现多样化的个性化功能。该镜像基于CentOS 7.9，PHP 7.4，MySQL 5.7，Apache 2.4。
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

Success response

JSON format

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "Images": [
    {
      "ImageType": "app",
      "Description": "WordPress是目前非常流行、强大的博客和内容管理网站的工具平台，借助第三方开发的模板、插件，用户可实现多样化的个性化功能。该镜像基于CentOS 7.9，PHP 7.4，MySQL 5.7，Apache 2.4。",
      "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.
500	InternalError	An error occurred while processing your request.
403	InvalidParam	The specified parameter value is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.