文档

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

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
MaxResultsinteger

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

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

下一个查询开始的 Token。

caeba0bbb2be03f84eb48b699f0a4883
BundleTypestring

云电脑模板类型。

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

云电脑规格族。

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

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

2
MemorySizeinteger

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

4
GpuCountfloat

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

1
CheckStockboolean

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

true
FromDesktopGroupboolean

是否属于云电脑池。

枚举值:
  • true属于云电脑池
  • false不属于云电脑池 [默认值]
false
ProtocolTypestring

协议类型。

枚举值:
  • HDXHDX协议
  • ASP阿里云自研ASP协议 [推荐]
ASP
BundleIdarray

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

string

云电脑模板 ID。

bundle_ecd_graphics.2xlarge_s15d15_win2019
SupportMultiSessionboolean

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

false
VolumeEncryptionEnabledboolean

是否开启磁盘加密。

false
FotaChannelstring

邀测中,暂未开放使用。

example
SelectedBundleboolean

精选模板。

true
SessionTypestring

会话类型。

枚举值:
  • SingleSession单会话
  • MultipleSession多会话
SingleSession
ImageIdarray

镜像 ID 列表。

string

镜像 ID。

m-7by8d2m4kiiczgd69
OsTypestring

操作系统类型。

枚举值:
  • LinuxLinux
  • WindowsWindows
Windows
Scopestring

使用场景。

FastBuy

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

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

AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8
RequestIdstring

请求 ID。

BCC854D8-5D1E-46D3-96EF-797A5DD36789
Bundlesobject []

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

Descriptionstring

云电脑模板描述。

test
BundleTypestring

云电脑模板类型。

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

操作系统类型。

枚举值:
  • LinuxLinux
  • WindowsWindows
Windows
StockStatestring

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

Sufficient
DesktopTypestring

云电脑规格。

ecd.graphics.2xlarge
ProtocolTypestring

协议类型。

枚举值:
  • HDXHDX协议
  • 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
Disksobject []

磁盘信息。

DiskTypestring

磁盘类型。

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

磁盘大小。单位:GiB。

150
DiskPerformanceLevelstring

磁盘性能等级。

枚举值:
  • PL1PL1
  • PL0PL0
  • PL3PL3
  • PL2PL2
PL0
DesktopTypeAttributeobject

云电脑规格详情。

CpuCountinteger

vCPU 数量。

10
GpuCountfloat

GPU 个数。

0.5
GpuSpecstring

GPU 类型。

NVIDIA T4
MemorySizeinteger

内存大小。单位:MiB。

4096
DesktopTypeFamilystring

云电脑规格族。

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

云电脑模板的创建时间。

2021-09-30T06:09Z
SessionTypestring

会话类型。

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

是否开启磁盘加密。

false
VolumeEncryptionKeystring

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

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

操作系统平台信息。

枚举值:
  • UbuntuUbuntu
  • Windows Server 2022Windows Server 2022
  • UOSUOS
  • CentOSCentOS
  • Windows Server 2019Windows Server 2019
  • Windows Server 2016Windows Server 2016
Windows Server 2019
ImageStatusstring

镜像状态。

Available

示例

正常返回示例

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"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-06-10OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Scope
2023-04-27OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:OsType
2023-03-17OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ImageId
出参OpenAPI 返回结构发生变更
2023-01-05OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:SessionType
2022-01-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-10-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-10-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-05新增 OpenAPI看变更集
  • 本页导读 (0)
文档反馈