调用ListImages获取镜像列表_人工智能平台 PAI(PAI)-阿里云帮助中心

获取镜像列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
paiimage:ListImages	list	全部资源 *	无	无

请求语法

GET /api/v1/images HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Name	string	否	镜像名称，支持模糊搜索。	tensorflow_2.9
PageNumber	integer	否	镜像列表的页码。起始值为 1，默认为 1。	1
PageSize	integer	否	分页查询时设置的每页行数。默认为 20。	20
SortBy	string	否	分页查询时的排序字段。目前 GmtCreateTime 字段用于排序。	GmtCreateTime
Order	string	否	分页查询时，对指定的排序字段进行升序或降序，与 SortBy 结合使用。默认 ASC。 ASC：升序。 DESC：降序。	DESC
Labels	string	否	标签过滤条件，多个条件以半角逗号（,）分隔。单个条件过滤格式为`Key=Value`。 Key 支持如下值： 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	否	是否显示非必要信息，非必要信息目前包含 Labels。取值如下： true：包含非必要信息。 false：不包含非必要信息。	true
WorkspaceId	string	否	工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。	20******55
UserId	string	否	创建者的阿里云账号 UID。	155**********904
ParentUserId	string	否	创建者的阿里云账号 UID。	155**********904
Query	string	否	模糊搜索镜像名称以及描述。	name
Accessibility	string	否	镜像的可见性，目前只对自定义镜像生效。 PUBLIC 表示公开。 PRIVATE 表示私有。	PUBLIC

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求 ID。	5A14FA81-DD4E-******-6343FE44B941
TotalCount	long	返回的镜像总量。	2
Images	array<object>	镜像列表。
Images	object	镜像详情。
Name	string	镜像名称。	tensorflow_2.9
GmtCreateTime	string	创建 UTC 时间，日期格式为 ISO8601。	2021-01-21T17:12:35.232Z
Description	string	镜像描述。	desc
ImageUri	string	镜像地址，包含版本号。	registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0
Labels	array<object>	镜像标签列表。
Labels	object	镜像标签。
Key	string	标签的键。	system.chipType
Value	string	标签的值。	GPU
ImageId	string	镜像 ID。	image-tzi7f9******s45t
Accessibility	string	镜像的可见性，可能值： PUBLIC：当前工作空间所有成员都可以操作。 PRIVATE：只有创建者可以操作。	PUBLIC
GmtModifiedTime	string	修改 UTC 时间，格式为 ISO8601。	2021-01-21T17:12:35.232Z
UserId	string	创建者的阿里云账号 UID。	155**********904
ParentUserId	string	创建者的阿里云账号 UID。	155**********904
WorkspaceId	string	工作空间 ID。	20******55
Size	integer	镜像大小，单位为 GB。	2

示例

正常返回示例

JSON格式

{
  "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
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-09-13	OpenAPI 入参发生变更	查看变更详情
2024-07-09	API 内部配置变更，不影响调用	查看变更详情
2023-07-24	OpenAPI 入参发生变更	查看变更详情
2023-06-26	OpenAPI 返回结构发生变更	查看变更详情
2023-05-16	OpenAPI 入参发生变更	查看变更详情
2022-08-12	OpenAPI 返回结构发生变更	查看变更详情
2021-09-22	新增 OpenAPI	查看变更详情