首页 无影云桌面 API参考(云桌面管控) API目录 桌面模板 DescribeBundles - 查询桌面模板的详细信息

DescribeBundles - 查询桌面模板的详细信息

调用DescribeBundles查询桌面模板的详细信息。

调试

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

调试

授权信息

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

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

请求参数

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

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

cn-hangzhou
MaxResultsinteger

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

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

下一个查询开始的Token。

caeba0bbb2be03f84eb48b699f0a4883
BundleTypestring

桌面模板类型。

SYSTEM
枚举值:
- SYSTEM: 系统模板
- CUSTOM: 自定义模板
DesktopTypeFamilystring

桌面规格族。

eds.general
枚举值:
- eds.graphics: 图形型
- eds.hf: 高主频型
- eds.general: 通用型
CpuCountinteger

桌面规格包含的vCPU。

2
MemorySizeinteger

桌面规格包含的内存大小。单位为GiB。

4
GpuCountnumber

桌面规格包含的GPU个数。

1
CheckStockboolean

是否查询桌面规格的库存状态。

true
FromDesktopGroupboolean

是否属于桌面组。默认为false

false
ProtocolTypestring

协议类型。

ASP
枚举值:
- HDX: HDX协议
- ASP: ASP(阿里巴巴自研ASP协议 [推荐])
BundleIdarray

桌面模板ID。可设置1~100个。

string

桌面模板ID。

bundle_ecd_graphics.2xlarge_s15d15_win2019
SupportMultiSessionboolean

查询桌面列表时是否返回多会话的桌面模板。默认不返回。

false
VolumeEncryptionEnabledboolean

是否开启磁盘加密。

false
FotaChannelstring
SelectedBundleboolean

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

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

AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8
RequestIdstring

请求ID。

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

桌面模板的详细信息。

object

桌面模板的详细信息。

Descriptionstring

桌面模板描述。

test
BundleTypestring

桌面模板类型。

SYSTEM
枚举值:
- SYSTEM: 系统模板
- CUSTOM: 自定义模板
OsTypestring

操作系统类型。

Windows
StockStatestring

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

Sufficient
DesktopTypestring

桌面规格。

ecd.graphics.2xlarge
ProtocolTypestring

协议类型。

ASP
枚举值:
- HDX: HDX协议
- ASP: ASP(阿里巴巴自研ASP协议
BundleIdstring

桌面模板ID。

bundle_ecd_graphics.2xlarge_s15d15_win2019
ImageIdstring

镜像ID。

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

镜像名称。

Windows server 2019 Chinese
Languagestring

镜像操作系统语言。

en-US
BundleNamestring

桌面模板名称。

Advanced graphics with Windows 2019
Disksarray

磁盘信息。

object

磁盘信息。

DiskTypestring

磁盘类型。

SYSTEM
枚举值:
- SYSTEM: 系统盘
- DATA: 数据盘
DiskSizeinteger

磁盘大小。单位:GiB。

150
DiskPerformanceLevelstring

磁盘性能等级。

PL0
DesktopTypeAttributeobject

桌面规格详情。

CpuCountinteger

CPU个数。

10
GpuCountnumber

GPU个数。

0.5
GpuSpecstring

GPU类型。

NVIDIA T4
MemorySizeinteger

内存大小。单位:MB。

47104
DesktopTypeFamilystring

桌面规格族。

eds.general
枚举值:
- eds.graphics: 图形型
- eds.hf: 高主频型
- eds.general: 通用型
CreationTimestring

桌面模板的创建时间。

2021-09-30T06:09Z
SessionTypestring

会话类型。

0
枚举值:
- 0: 单会话
- 1: 多会话
VolumeEncryptionEnabledboolean

是否开启磁盘加密。

false
VolumeEncryptionKeystring

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

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

示例

正常返回示例

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": 47104
      },
      "DesktopTypeFamily": "eds.general",
      "CreationTime": "2021-09-30T06:09Z",
      "SessionType": "0",
      "VolumeEncryptionEnabled": true,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "Platform": ""
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-01-20OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-10-28OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-10-28OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-05新增 OpenAPI
阿里云首页 无影云桌面 相关技术圈