赛尔校园公共服务平台 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
赛尔校园公共服务平台 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 无影云电脑企业版
  4. 开发参考
  5. API参考(云电脑管控)
  6. API目录
  7. 镜像
  8. DescribeImages - 查询镜像的详细信息

DescribeImages - 查询镜像的详细信息

  • 镜像
  • 发布于 2025-04-17
  • 0 次阅读
文档编辑
文档编辑

查询镜像的详细信息。

调试

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

调试

授权信息

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

请求参数

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

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

cn-hangzhou
MaxResultsinteger否

分页查询时每页行数。

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

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

caeba0bbb2be03f84eb48b699f0a4883
ImageTypestring否

镜像类型。

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

镜像状态。

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

是否为 GPU 类型镜像。

枚举值:
  • true:是GPU镜像。
  • false:不是GPU镜像。
false
ProtocolTypestring否

协议类型。

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

操作系统语言。

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

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

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
Imagesarray<object>

镜像信息组成的集合。

Imageobject

镜像信息。

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

操作系统语言。

Languagestring

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

枚举值:
  • 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 入参发生变更查看变更详情
2021-10-28OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2021-10-28OpenAPI 返回结构发生变更查看变更详情
相关文章

CreateImage - 创建自定义镜像 2025-04-17 11:21

通过已部署好的云电脑创建自定义镜像,以便快速创建更多相同配置的云电脑,避免每次创建时重复配置。

CopyImage - 跨地域复制镜像 2025-04-17 11:21

将镜像复制到另一地域。如需跨地域分享镜像,可以先调用本接口将镜像复制到新地域再进行分享。

UploadImage - 上传自定义Windows镜像 2025-04-17 11:21

上传用户的自定义Windows镜像。 接口说明

DescribeImages - 查询镜像的详细信息 2025-04-17 11:21

查询镜像的详细信息。

DescribeImageModifiedRecords - 查询镜像变更记录 2025-04-17 11:21

查询云电脑的镜像变更记录。

DescribeImagePermission - 获取镜像已共享的阿里云账号列表 2025-04-17 11:21

获取当前镜像已共享的阿里云账号列表。 接口说明

目录
Copyright © 2025 your company All Rights Reserved. Powered by 赛尔网络.
京ICP备14022346号-15
gongan beian 京公网安备11010802041014号