首页 无影云电脑 开发参考 API参考（云桌面管控） API目录 镜像 DescribeImages - 查询镜像的详细信息

DescribeImages - 查询镜像的详细信息

更新时间: 2023-07-26 17:41:09

查询镜像的详细信息。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:DescribeImagesLIST
  • ECD
    acs:ecd:{#regionId}:{#accountId}:*
    无
无

请求参数

名称类型必填描述示例值
RegionIdstring是

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

cn-hangzhou
MaxResultsinteger否

分页查询时每页行数。

  • 最大值：100
  • 默认值：10
10
NextTokenstring否

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

caeba0bbb2be03f84eb48b699f0a4883
ImageTypestring否

镜像类型。

枚举值：
  • SYSTEM：系统镜像。
  • CUSTOM：自定义镜像。
SYSTEM
ImageStatusstring否

镜像状态。

枚举值：
  • Creating：创建中。
  • Available：可用。
  • CreateFailed：创建失败。
Available
GpuCategoryboolean否

是否为GPU类型镜像。

false
ProtocolTypestring否

协议类型。

枚举值：
  • HDX：HDX协议。
  • ASP：阿里巴巴自研ASP协议 [推荐]。
ASP
LanguageTypestring否

操作系统语言。

枚举值：
  • en-US：英文。
  • zh-HK：繁体中文（香港）。
  • zh-CN：简体中文。
  • ja-JP：日文。
en-US
DesktopInstanceTypestring否

桌面规格。可调用DescribeBundles获取该参数。

ecd.graphics.xlarge
ImageIdarray否

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

string否

镜像ID。

m-gx2x1dhsmusr2****
OsTypestring否

系统类型，默认为null。

枚举值：
  • Linux：Linux。
  • Windows：Windows。
Windows
GpuDriverVersionstring否

GPU驱动版本号。

417.22
SessionTypestring否

会话类型。

枚举值：
  • SINGLE_SESSION：单会话镜像。
  • MULTIPLE_SESSION：多会话镜像。
SINGLE_SESSION
FotaVersionstring否

镜像版本信息。

0.0.3-R-20220616.133609
ImageNamestring否

镜像名称。

Win_01

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求ID。

4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB
Imagesobject []

镜像信息组成的集合。

CreationTimestring

镜像的创建时间。

2018-01-10T01:01:10Z
Statusstring

镜像状态。

枚举值：
  • Creating：创建中。
  • Available：可用。
  • CreateFailed：创建失败。
Available
Progressstring

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

100%
DataDiskSizeinteger

数据盘大小。单位：GiB。

150
ImageTypestring

镜像类型。

枚举值：
  • SYSTEM：系统镜像。
  • CUSTOM：自定义镜像。
SYSTEM
Descriptionstring

镜像描述。

This is description.
Sizeinteger

镜像大小。单位：GiB。

40
OsTypestring

操作系统类型。

WINDOWS
ProtocolTypestring

协议类型。

枚举值：
  • HDX：HDX协议。
  • ASP：阿里巴巴自研ASP协议 [推荐]。
ASP
Namestring

镜像名称。

testImageName
ImageIdstring

镜像ID。

m-gx2x1dhsmusr2****
GpuCategoryboolean

是否为GPU类型镜像。

false
SupportedLanguagesarray

操作系统语言。

string

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

枚举值：
  • en-US：英文。
  • zh-HK：繁体中文（香港）。
  • zh-CN：简体中文。
  • ja-JP：日文。
en-US
GpuDriverVersionstring

GPU驱动版本号。

417.22
AppVersionstring

镜像版本。

1.0.0
VolumeEncryptionEnabledboolean

是否开启磁盘加密。

false
VolumeEncryptionKeystring

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

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

已共享的镜像数量。

1
SessionTypestring

镜像会话类型，可能值：

  • SINGLE_SESSION：单会话镜像
  • MULTIPLE_SESSION：多会话镜像
MULTIPLE_SESSION
UpdateTimestring

最后修改镜像的时间。

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

镜像的操作系统类型。

枚举值：
  • 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"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-06-13OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参：FotaVersion
    新增入参：ImageName
2021-10-28OpenAPI 入参发生变更，OpenAPI 返回结构发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参：OsType
    新增入参：GpuDriverVersion
出参OpenAPI 返回结构发生变更
2021-10-28OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 无影云电脑 相关技术圈