调用ListImages获取PAI-DLC的镜像列表。

调试

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

请求语法

GET /api/v1/images?ImageProviderType=String&AcceleratorType=String&Framework=String&SortBy=String&Order=String HTTP/1.1
Content-Type:application/json

请求参数

表 1. 请求Query参数
参数名称 类型 是否必选 示例 说明
ImageProviderType String 否 Community

镜像提供源，枚举

  • Community
  • PAI

默认为空，代表所有来源。
AcceleratorType String 否 gpu

加速器类型，枚举：

  • cpu
  • gpu

默认为空，代表所有类型。
Framework String 否 PyTorchJob

镜像包含的框架类型，枚举

  • PyTorchJob
  • TFJob

默认为空，带有任意类型。
SortBy String 否 GmtCreateTime

按返回字段排序，枚举：

  • ImageProvideType
  • AcceleratorType
  • Framework
Order String 否 desc

排序顺序，枚举：

  • desc
  • asc

响应体语法

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Images" : [ {
    "ImageTag" : "String",
    "ImageUrl" : "String",
    "ImageUrlVpc" : "String",
    "ImageProviderType" : "String",
    "AcceleratorType" : "String",
    "Framework" : "String"
  } ],
  "TotalCount" : Long,
  "RequestId" : "String"
}

响应参数

表 2. 响应Body参数
参数名称 类型 示例 说明
Images Array of ImageItem

镜像详情列表
TotalCount Long 1

符合过滤条件的镜像总数量
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

本次调用的请求ID，用于诊断和答疑。

获取指定类型的镜像

GET /api/v1/images?ImageProviderType=Community&AcceleratorType=gpu&Framework=PyTorchJob&SortBy=GmtCreateTime&Order=desc HTTP/1.1 
Host:pai-dlc.aliyuncs.com 
Content-Type:application/json

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<Images>
    <ImageTag>tensorflow-training:2.3-cpu-py36-ubuntu18.04</ImageTag>
    <ImageUrl>registry.cn-beijing.aliyuncs.com/pai-dlc/tensorflow-training:2.3-cpu-py36-ubuntu18.04</ImageUrl>
    <ImageUrlVpc>registry-vpc.cn-beijing.aliyuncs.com/pai-dlc/tensorflow-training:2.3-cpu-py36-ubuntu18.04</ImageUrlVpc>
    <ImageProviderType>Community</ImageProviderType>
    <AcceleratorType>gpu</AcceleratorType>
    <Framework>PyTorchJob</Framework>
</Images>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Images" : [ {
    "ImageTag" : "tensorflow-training:2.3-cpu-py36-ubuntu18.04",
    "ImageUrl" : "registry.cn-beijing.aliyuncs.com/pai-dlc/tensorflow-training:2.3-cpu-py36-ubuntu18.04",
    "ImageUrlVpc" : "registry-vpc.cn-beijing.aliyuncs.com/pai-dlc/tensorflow-training:2.3-cpu-py36-ubuntu18.04",
    "ImageProviderType" : "Community",
    "AcceleratorType" : "gpu",
    "Framework" : "PyTorchJob"
  } ],
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

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

开发者资源

  • SDK

    阿里云为您提供多种语言的SDK，帮助您快速通过API集成阿里云的产品和服务，推荐您使用SDK调用API，已免除您手动签名验证。

  • OpenAPI Explorer

    快速检索，可视化调试API，在线命令行工具，同步动态生成可执行的SDK代码示例。

  • 阿里云CLI

    阿里云资产管理和配置工具，可通过命令方式同时管理多个阿里云产品和服务，简单快捷，是您上云好帮手。