ListImages - Platform For AI - Alibaba Cloud Documentation Center

Queries a list of 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

paiimage:ListImages

list

*All Resource

*

None

Request syntax

GET /api/v1/images HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the image. Fuzzy search is supported.	tensorflow_2.9
PageNumber	integer	No	The page number of the image list. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. The default value is 20.	20
SortBy	string	No	The field to use for sorting in a paged query. Currently, only the GmtCreateTime field is used for sorting.	GmtCreateTime
Order	string	No	The order in which to sort the results of a paged query. This parameter is used with SortBy. The default value is ASC. ASC: ascending order. DESC: descending order.	DESC
Labels	string	No	The filter conditions for labels. Separate multiple conditions with commas (,). The format for a single filter condition is `Key=Value`. The supported values for Key are: system.chipType system.dsw.cudaVersion system.dsw.fromImageId system.dsw.fromInstanceId system.dsw.id system.dsw.os system.dsw.osVersion system.dsw.resourceType system.dsw.rootImageId system.dsw.stage system.dsw.tag system.dsw.type system.framework system.origin system.pythonVersion system.source system.supported.dlc system.supported.dsw	system.framework=XGBoost 1.6.0,system.official=true
Verbose	boolean	No	Specifies whether to display non-essential information. Non-essential information currently includes Labels. Valid values: true: Includes non-essential information. false: Does not include non-essential information.	true
WorkspaceId	string	No	The workspace ID. For more information about how to obtain a workspace ID, see ListWorkspaces.	20******55
Query	string	No	Performs a fuzzy search by image name and description.	name
Accessibility	string	No	The visibility of the image. This parameter is valid only for custom images. PUBLIC: The image is public. PRIVATE: The image is private.	PUBLIC
ImageUri	string	No

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	5A14FA81-DD4E-******-6343FE44B941
TotalCount	integer	The total number of returned images.	2
Images	array<object>	The list of images.
	array<object>	The image details.
Name	string	The image name.	tensorflow_2.9
GmtCreateTime	string	The time when the image was created. The time is in UTC and the format is ISO 8601.	2021-01-21T17:12:35.232Z
Description	string	The image description.	desc
ImageUri	string	The image URL, which includes the version number.	registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0
Labels	array<object>	The list of image labels.
	object	The image label.
Key	string	The key of the label.	system.chipType
Value	string	The value of the label.	GPU
ImageId	string	The image ID.	image-tzi7f9******s45t
Accessibility	string	The visibility of the image. Valid values: PUBLIC: All members in the current workspace can perform operations on the image. PRIVATE: Only the creator can perform operations on the image.	PUBLIC
GmtModifiedTime	string	The time when the image was last modified. The time is in UTC and the format is ISO 8601.	2021-01-21T17:12:35.232Z
UserId	string	The UID of the Alibaba Cloud account that created the image.	155**********904
ParentUserId	string	The UID of the Alibaba Cloud account that created the image.	155**********904
WorkspaceId	string	The workspace ID.	20******55
Size	integer	The image size in bytes.	2
SourceType	string	The type of the image source.
SourceId	string	The ID of the image source.

Examples

Success response

JSON format

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "TotalCount": 2,
  "Images": [
    {
      "Name": "tensorflow_2.9",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "Description": "desc",
      "ImageUri": "registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0",
      "Labels": [
        {
          "Key": "system.chipType",
          "Value": "GPU"
        }
      ],
      "ImageId": "image-tzi7f9******s45t",
      "Accessibility": "PUBLIC",
      "GmtModifiedTime": "2021-01-21T17:12:35.232Z\n",
      "UserId": "155**********904",
      "ParentUserId": "155**********904",
      "WorkspaceId": "20******55",
      "Size": 2,
      "SourceType": "",
      "SourceId": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.