DescribeAICImages API reference for AIC images - ENS

Retrieve image information.

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

ens:DescribeAICImages

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ImageId	string	No	The image ID of the AIC instance.	m-ad0ddaddc2d54adeaa09b7c0f1e****
ImageUrl	string	No	The URL of the AIC image repository.	****.alibaba-inc.com/aic/socimage:test
PageNumber	string	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	string	No	The number of entries per page. The maximum value is 100. Default value: 10.	10
Status	string	No	The status of the image. Valid values: verifying disable available Valid values: verifying : verifying disable : disable available : available	available
MinDate	string	No	The beginning of the time range to query. Specify the time in the 2006-01-02 format. By default, the time range to query is not restricted.	2022-01-02
MaxDate	string	No	The end of the time range to query. Specify the time in the 2006-01-02 format. By default, the time range to query is not restricted.	2022-02-02
ImageType	string	No	The type of the image. Valid values: public: public image private: custom image Valid values: private : private public : public	public
Description	string	No	The description of the image.	ConsoleTestoperation

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	72DC6C0A-D9A8-5345-A2BE-FE354CC728A0
Images	array<object>	The information about the images.
	object	The information about the image.
ImageUrl	string	The URL of the AIC image repository.	****.alibaba-inc.com/aic/socimage:test
ImageId	string	The image ID of the AIC instance.	m-ad0ddaddc2d54adeaa09b7c0f1e****
User	string	The username of the image repository.	user
Status	string	The status of the image. Available is returned for this parameter. Available indicates that the image is available.	available
CreationTime	string	The time when the image was created.	2022-01-22 10:54:34
Description	string	The description of the image.	ConsoleTestoperation
AndroidVersion	string	The Android version of the image.	10
PageNumber	integer	The page number. Default value: 1.	1
PageSize	integer	The number of entries per page. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	1

Examples

Success response

JSON format

{
  "RequestId": "72DC6C0A-D9A8-5345-A2BE-FE354CC728A0",
  "Images": [
    {
      "ImageUrl": "****.alibaba-inc.com/aic/socimage:test",
      "ImageId": "m-ad0ddaddc2d54adeaa09b7c0f1e****",
      "User": "user",
      "Status": "available",
      "CreationTime": "2022-01-22 10:54:34",
      "Description": "ConsoleTestoperation",
      "AndroidVersion": "10"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.