AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

DescribeImages - 查询镜像的详细信息

更新时间：
复制为 MD 格式
产品详情
我的收藏

查询镜像的详细信息。

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeImages

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
MaxResults

integer

否

分页查询时每页行数。

  • 最大值：100

  • 默认值：10

10
NextToken

string

否

下一个查询开始的 Token，NextToken 为空表示没有下一个。

caeba0bbb2be03f84eb48b699f0a4883
ImageType

string

否

镜像类型。

枚举值：

  • SYSTEM :

    系统镜像

  • CUSTOM :

    自定义镜像

SYSTEM
ImageStatus

string

否

镜像状态。

枚举值：

  • Creating :

    创建中

  • Available :

    可用

  • CreateFailed :

    创建失败

Available
GpuCategory

boolean

否

是否为 GPU 类型镜像。

枚举值：

  • true :

    是 GPU 镜像

  • false :

    不是 GPU 镜像

false
ProtocolType

string

否

协议类型。

枚举值：

  • HDX :

    HDX 协议

  • ASP :

    阿里云自研 ASP 协议 [推荐]

ASP
LanguageType

string

否

操作系统语言。

枚举值：

  • en-US :

    英文

  • zh-HK :

    繁体中文（香港）

  • zh-CN :

    简体中文

  • ja-JP :

    日文

en-US
DesktopInstanceType

string

否

云电脑规格。可调用 DescribeDesktopTypes 获取该参数。

ecd.graphics.xlarge
ImageId

array

否

镜像 ID。可设置一个或多个。

m-gx2x1dhsmusr2****

string

否

镜像 ID。

m-gx2x1dhsmusr2****
OsType

string

否

操作系统类型，默认为null。

枚举值：

  • Linux :

    Linux

  • Windows :

    Windows

Windows
GpuDriverVersion

string

否

GPU 驱动版本号。

417.22
SessionType

string

否

会话类型。

枚举值：

  • SINGLE_SESSION :

    单会话镜像

  • MULTIPLE_SESSION :

    多会话镜像

SINGLE_SESSION
FotaVersion

string

否

镜像版本信息。

0.0.3-R-20220616.133609
ImageName

string

否

镜像名称。

Win_01

返回参数

名称

类型

描述

示例值

object

返回信息集合。

NextToken

string

下一个查询开始的 Token，NextToken 为空表示没有下一个。

caeba0bbb2be03f84eb48b699f0a4883
RequestId

string

请求 ID。

4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB
Images

array<object>

镜像信息组成的集合。

object

镜像信息。

CreationTime

string

镜像的创建时间。

2018-01-10T01:01:10Z
Status

string

镜像状态。

枚举值：

  • Creating :

    创建中

  • Available :

    可用

  • CreateFailed :

    创建失败

Available
Progress

string

镜像创建完成的进度。单位：%。

100%
DataDiskSize

integer

数据盘大小。单位：GiB。

150
ImageType

string

镜像类型。

枚举值：

  • SYSTEM :

    系统镜像

  • CUSTOM :

    自定义镜像

SYSTEM
Description

string

镜像描述。

This is description.
Size

integer

镜像大小。单位：GiB。

40
OsType

string

操作系统类型。

WINDOWS
ProtocolType

string

协议类型。

枚举值：

  • HDX :

    HDX 协议

  • ASP :

    阿里云自研 ASP 协议 [推荐]

ASP
Name

string

镜像名称。

testImageName
ImageId

string

镜像 ID。

m-gx2x1dhsmusr2****
GpuCategory

boolean

是否为 GPU 类型镜像。

false
SupportedLanguages

array

操作系统语言。

string

操作系统语言。可包含一种或多种。

枚举值：

  • en-US :

    英文

  • zh-HK :

    繁体中文（香港）

  • zh-CN :

    简体中文

  • ja-JP :

    日文

en-US
GpuDriverVersion

string

GPU 驱动版本号。

417.22
AppVersion

string

镜像版本。

1.0.0
VolumeEncryptionEnabled

boolean

是否开启磁盘加密。

false
VolumeEncryptionKey

string

开启磁盘加密的情况下使用的 KMS 的密钥 ID。可通过 ListKeys 接口获取。

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
SharedCount

integer

已共享的镜像数量。

1
SessionType

string

镜像会话类型。

枚举值：

  • SINGLE_SESSION :

    单会话镜像

  • MULTIPLE_SESSION :

    多会话镜像

MULTIPLE_SESSION
UpdateTime

string

最后修改镜像的时间。

2021-12-22T02:48:43Z
Platform

string

镜像的操作系统类型。

枚举值：

  • Ubuntu :

    Ubuntu

  • Windows Server 2022 :

    Windows Server 2022

  • UOS :

    UOS

  • CentOS :

    CentOS

  • Windows Server 2019 :

    Windows Server 2019

  • Windows Server 2016 :

    Windows Server 2016

  • Windows 10 :

    Windows 10

Windows Server 2019

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB",
  "Images": [
    {
      "CreationTime": "2018-01-10T01:01:10Z",
      "Status": "Available",
      "Progress": "100%",
      "DataDiskSize": 150,
      "ImageType": "SYSTEM",
      "Description": "This is description.",
      "Size": 40,
      "OsType": "WINDOWS",
      "ProtocolType": "ASP",
      "Name": "testImageName",
      "ImageId": "m-gx2x1dhsmusr2****",
      "GpuCategory": false,
      "SupportedLanguages": [
        "en-US"
      ],
      "GpuDriverVersion": "417.22",
      "AppVersion": "1.0.0",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "SharedCount": 1,
      "SessionType": "MULTIPLE_SESSION",
      "UpdateTime": "2021-12-22T02:48:43Z",
      "Platform": "Windows Server 2019"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：UploadImage - 上传自定义Windows镜像下一篇：DescribeImageModifiedRecords - 查询镜像变更记录