文档

ListImages - 获取镜像列表

更新时间:

获取镜像列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/images

请求参数

名称类型必填描述示例值
Namestring

镜像名称,支持模糊搜索。

tensorflow_2.9
PageNumberinteger

镜像列表的页码。起始值为 1,默认为 1。

1
PageSizeinteger

分页查询时设置的每页行数。默认为 20。

20
SortBystring

分页查询时的排序字段。目前 GmtCreateTime 字段用于排序。

GmtCreateTime
Orderstring

分页查询时,对指定的排序字段进行升序或降序,与 SortBy 结合使用。默认 ASC。

  • ASC:升序。
  • DESC:降序。
DESC
Labelsstring

标签过滤条件,多个条件以半角逗号(,)分隔。 单个条件过滤格式为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
Verboseboolean

是否显示非必要信息,非必要信息目前包含 Labels。取值如下:

  • true:包含非必要信息。
  • false:不包含非必要信息。
true
WorkspaceIdstring

工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces

20******55
UserIdstring

创建者的阿里云账号 UID。

155**********904
ParentUserIdstring

创建者的阿里云账号 UID。

155**********904
Querystring

模糊搜索镜像名称以及描述。

name
Accessibilitystring

镜像的可见性,目前只对自定义镜像生效。

  • PUBLIC 表示公开。
  • PRIVATE 表示私有。
PUBLIC

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求 ID。

5A14FA81-DD4E-******-6343FE44B941
TotalCountlong

返回的镜像总量。

2
Imagesobject []

镜像列表。

Namestring

镜像名称。

tensorflow_2.9
GmtCreateTimestring

创建 UTC 时间,日期格式为 ISO8601。

2021-01-21T17:12:35.232Z
Descriptionstring

镜像描述。

desc
ImageUristring

镜像地址,包含版本号。

registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0
Labelsobject []

镜像标签列表。

Keystring

标签的键。

system.chipType
Valuestring

标签的值。

GPU
ImageIdstring

镜像 ID。

image-tzi7f9******s45t
Accessibilitystring

镜像的可见性,可能值:

  • PUBLIC:当前工作空间所有成员都可以操作。
  • PRIVATE:只有创建者可以操作。
PUBLIC
GmtModifiedTimestring

修改 UTC 时间,格式为 ISO8601。

2021-01-21T17:12:35.232Z
UserIdstring

创建者的阿里云账号 UID。

155**********904
ParentUserIdstring

创建者的阿里云账号 UID。

155**********904
WorkspaceIdstring

工作空间 ID。

20******55
Sizeinteger

镜像大小,单位为 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
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-24OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Accessibility
2023-06-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-16OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Query
2022-08-12OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-09-22新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈