调用GetImage获取镜像_机器学习平台 PAI-阿里云帮助中心

获取镜像详情。

调试

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

调试

授权信息

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

请求语法

GET /api/v1/images/{ImageId}

请求参数

名称	类型	必填	描述	示例值
ImageId	string	是	镜像ID。如何获取镜像ID，请参见ListImages 。	image-4c62******53uor
Verbose	boolean	否	是否显示非必要信息，非必要信息目前包含Labels。取值如下： false（默认值）：不显示非必要信息。 true：显示非必要信息。	false

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求ID。	5A14FA81-DD4E-******-6343FE44B941
GmtCreateTime	string	镜像的创建UTC时间，格式ISO8601。	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	镜像的修改UTC时间，格式ISO8601。	2021-01-21T17:12:35.232Z
Name	string	镜像名称。	nlp-compression
Description	string	镜像描述。	NLP模型压缩训练镜像
ImageUri	string	镜像地址，包含版本号。	registry.cn-hangzhou.aliyuncs.******ession/nlp:gpu
UserId	string	创建镜像的UID。	15577******8921
ParentUserId	string	创建者的阿里云账号。	15577******8921
Labels	object []	镜像标签列表，数组类型，数组每一项包含Key和Value两个字段。官方镜像带有标签：key为system.official；value为true。
Key	string	标签的键。	system.chipType
Value	string	标签的值。	GPU
WorkspaceId	string	镜像所属的工作空间ID。	15945
Accessibility	string	镜像的可见性，可能值： PUBLIC：当前工作空间所有成员都可以操作。 PRIVATE：只有创建者可以操作。	PUBLIC
Size	integer	镜像大小，单位为GB。	10

示例

正常返回示例

JSON格式

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "GmtCreateTime": "2021-01-21T17:12:35.232Z",
  "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
  "Name": "nlp-compression\n",
  "Description": "NLP模型压缩训练镜像\n",
  "ImageUri": "registry.cn-hangzhou.aliyuncs.******ession/nlp:gpu\n",
  "UserId": "15577******8921",
  "ParentUserId": "15577******8921",
  "Labels": [
    {
      "Key": "system.chipType\n",
      "Value": "GPU"
    }
  ],
  "WorkspaceId": "15945",
  "Accessibility": "PUBLIC",
  "Size": 10
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-06-26

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更

2022-08-12

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更

2021-09-22

新增 OpenAPI

看变更集