GetImage - 获取镜像

获取镜像详情。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paiimage:GetImage

get

*全部资源

*

请求语法

GET /api/v1/images/{ImageId} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

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

array<object>

镜像标签列表,数组类型,数组每一项包含 Key 和 Value 两个字段。 官方镜像带有标签:key 为 system.official;value 为 true。

object

镜像标签。

Key

string

标签的键。

system.chipType

Value

string

标签的值。

GPU

WorkspaceId

string

镜像所属的工作空间 ID。

15945

Accessibility

string

镜像的可见性,可能值:

  • PUBLIC:当前工作空间所有成员都可以操作。

  • PRIVATE:只有创建者可以操作。

PUBLIC

Size

integer

镜像大小,单位为 byte。

10

SourceType

string

镜像来源类型

SourceId

string

镜像来源 ID

示例

正常返回示例

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,
  "SourceType": "",
  "SourceId": ""
}

错误码

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

变更历史

更多信息,参考变更详情