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

DescribeBundles - 查询云电脑模板的详细信息

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

查询云电脑模板的详细信息。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

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

cn-hangzhou
MaxResults

integer

否

分页查询时，每页最大行数。

  • 最大值：100

  • 默认值：10

10
NextToken

string

否

下一个查询开始的 Token。

caeba0bbb2be03f84eb48b699f0a4883
BundleType

string

否

云电脑模板类型。

枚举值：

  • SYSTEM :

    系统模板

  • CUSTOM :

    自定义模板

SYSTEM
DesktopTypeFamily

string

否

云电脑规格族。

枚举值：

  • eds.graphics :

    图形型

  • eds.hf :

    高主频型

  • eds.general :

    通用型

eds.general
CpuCount

integer

否

云电脑规格包含的 vCPU 数量。

2
MemorySize

integer

否

云电脑规格包含的内存大小。单位为 GiB。

4
GpuCount

number

否

云电脑规格包含的 GPU 个数。

1
CheckStock

boolean

否

是否查询云电脑规格的库存状态。

true
FromDesktopGroup

boolean

否

是否属于云电脑池。

枚举值：

  • true :

    属于云电脑池

  • false :

    不属于云电脑池 [默认值]

false
ProtocolType

string

否

协议类型。

枚举值：

  • HDX :

    HDX 协议

  • ASP :

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

ASP
BundleId

array

否

云电脑模板 ID 列表。可设置 1~100 个。

bundle_ecd_graphics.2xlarge_s15d15_win2019

string

否

云电脑模板 ID。

bundle_ecd_graphics.2xlarge_s15d15_win2019
SupportMultiSession

boolean

否

查询云电脑列表时是否返回多会话的云电脑模板。默认不返回。

false
VolumeEncryptionEnabled

boolean

否

是否开启磁盘加密。

false
FotaChannel

string

否

说明

此参数暂未对外开放使用。

example
SelectedBundle

boolean

否

精选模板。

true
SessionType

string

否

会话类型。

枚举值：

  • SingleSession :

    单会话

  • MultipleSession :

    多会话

SingleSession
ImageId

array

否

镜像 ID 列表。

string

否

镜像 ID。

m-7by8d2m4kiicz****
OsType

string

否

操作系统类型。

枚举值：

  • Linux :

    Linux

  • Windows :

    Windows

Windows
Scope

string

否

使用场景。

FastBuy
GpuDriverType

string

否

GPU 驱动类型。

枚举值：

  • T4 :

    T4

  • A10 :

    A10

  • G28 :

    G28

  • G39 :

    G39

T4

返回参数

名称

类型

描述

示例值

object

返回信息集合。

NextToken

string

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

AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8
RequestId

string

请求 ID。

BCC854D8-5D1E-46D3-96EF-797A5DD36789
Bundles

array<object>

云电脑模板的详细信息列表。

array<object>

云电脑模板的详细信息。

Description

string

云电脑模板描述。

test
BundleType

string

云电脑模板类型。

枚举值：

  • SYSTEM :

    系统模板

  • CUSTOM :

    自定义模板

SYSTEM
OsType

string

操作系统类型。

枚举值：

  • Linux :

    Linux

  • Windows :

    Windows

Windows
StockState

string

库存状态。当CheckStock设置为True时返回。

Sufficient
DesktopType

string

云电脑规格。

ecd.graphics.2xlarge
ProtocolType

string

协议类型。

枚举值：

  • HDX :

    HDX 协议

  • ASP :

    阿里云自研 ASP 协议

ASP
BundleId

string

云电脑模板 ID。

bundle_ecd_graphics.2xlarge_s15d15_win2019
ImageId

string

镜像 ID。

desktopimage-windows-server-2019-64-ch-vgpu
ImageName

string

镜像名称。

Windows server 2019 Chinese
Language

string

镜像操作系统语言。

枚举值：

  • en-US :

    英文

  • zh-HK :

    繁体中文（香港）

  • zh-CN :

    简体中文

  • ja-JP :

    日文

en-US
BundleName

string

云电脑模板名称。

Advanced graphics with Windows 2019
Disks

array<object>

磁盘信息。

object

磁盘信息。

DiskType

string

磁盘类型。

枚举值：

  • SYSTEM :

    系统盘

  • DATA :

    数据盘

SYSTEM
DiskSize

integer

磁盘大小。单位：GiB。

150
DiskPerformanceLevel

string

磁盘性能等级。

枚举值：

  • PL1 :

    PL1

  • PL0 :

    PL0

  • PL3 :

    PL3

  • PL2 :

    PL2

PL0
DesktopTypeAttribute

object

云电脑规格详情。

CpuCount

integer

vCPU 数量。

10
GpuCount

number

GPU 个数。

0.5
GpuSpec

string

GPU 类型。

NVIDIA T4
MemorySize

integer

内存大小。单位：MiB。

4096
DesktopTypeFamily

string

云电脑规格族。

枚举值：

  • eds.graphics :

    图形型

  • eds.hf :

    高主频型

  • eds.general :

    通用型

eds.general
CreationTime

string

云电脑模板的创建时间。

2021-09-30T06:09Z
SessionType

string

会话类型。

枚举值：

  • 0 :

    单会话

  • 1 :

    多会话

0
VolumeEncryptionEnabled

boolean

是否开启磁盘加密。

false
VolumeEncryptionKey

string

开启磁盘加密的情况下使用的 KMS 的密钥 ID。

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
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 Server 2019
ImageStatus

string

镜像状态。

Available
SystemDiskCategory

string

系统盘类型。

枚举值：

  • cloud_efficiency :

    高效云盘

  • cloud_auto :

    极速云盘

  • cloud_essd :

    增强型 SSD 云盘，仅部分规格支持

cloud_efficiency
DataDiskCategory

string

数据盘类型。

枚举值：

  • cloud_efficiency :

    高效云盘

  • cloud_auto :

    极速云盘

  • cloud_essd :

    增强型 SSD 云盘，仅部分规格支持

cloud_efficiency

示例

正常返回示例

JSON格式

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8",
  "RequestId": "BCC854D8-5D1E-46D3-96EF-797A5DD36789",
  "Bundles": [
    {
      "Description": "test",
      "BundleType": "SYSTEM",
      "OsType": "Windows",
      "StockState": "Sufficient",
      "DesktopType": "ecd.graphics.2xlarge",
      "ProtocolType": "ASP",
      "BundleId": "bundle_ecd_graphics.2xlarge_s15d15_win2019",
      "ImageId": "desktopimage-windows-server-2019-64-ch-vgpu",
      "ImageName": "Windows server 2019 Chinese",
      "Language": "en-US",
      "BundleName": "Advanced graphics with Windows 2019",
      "Disks": [
        {
          "DiskType": "SYSTEM",
          "DiskSize": 150,
          "DiskPerformanceLevel": "PL0"
        }
      ],
      "DesktopTypeAttribute": {
        "CpuCount": 10,
        "GpuCount": 0.5,
        "GpuSpec": "NVIDIA T4",
        "MemorySize": 4096
      },
      "DesktopTypeFamily": "eds.general",
      "CreationTime": "2021-09-30T06:09Z",
      "SessionType": "0",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "Platform": "Windows Server 2019",
      "ImageStatus": "Available",
      "SystemDiskCategory": "cloud_efficiency",
      "DataDiskCategory": "cloud_efficiency"
    }
  ]
}

错误码

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

变更历史

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

上一篇：CreateBundle - 创建自定义云电脑模板下一篇：ModifyBundle - 修改自定义云电脑模板