查询云电脑模板的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecd:DescribeBundles | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
MaxResults | integer | 否 | 分页查询时,每页最大行数。
| 10 |
NextToken | string | 否 | 下一个查询开始的 Token。 | caeba0bbb2be03f84eb48b699f0a4883 |
BundleType | string | 否 | 云电脑模板类型。 枚举值:
| SYSTEM |
DesktopTypeFamily | string | 否 | 云电脑规格族。 枚举值:
| eds.general |
CpuCount | integer | 否 | 云电脑规格包含的 vCPU 数量。 | 2 |
MemorySize | integer | 否 | 云电脑规格包含的内存大小。单位为 GiB。 | 4 |
GpuCount | float | 否 | 云电脑规格包含的 GPU 个数。 | 1 |
CheckStock | boolean | 否 | 是否查询云电脑规格的库存状态。 | true |
FromDesktopGroup | boolean | 否 | 是否属于云电脑池。 枚举值:
| false |
ProtocolType | string | 否 | 协议类型。 枚举值:
| ASP |
BundleId | array | 否 | 云电脑模板 ID 列表。可设置 1~100 个。 | |
string | 否 | 云电脑模板 ID。 | bundle_ecd_graphics.2xlarge_s15d15_win2019 | |
SupportMultiSession | boolean | 否 | 查询云电脑列表时是否返回多会话的云电脑模板。默认不返回。 | false |
VolumeEncryptionEnabled | boolean | 否 | 是否开启磁盘加密。 | false |
FotaChannel | string | 否 | 说明
此参数暂未对外开放使用。
| example |
SelectedBundle | boolean | 否 | 精选模板。 | true |
SessionType | string | 否 | 会话类型。 枚举值:
| SingleSession |
ImageId | array | 否 | 镜像 ID 列表。 | |
string | 否 | 镜像 ID。 | m-7by8d2m4kiicz**** | |
OsType | string | 否 | 操作系统类型。 枚举值:
| Windows |
Scope | string | 否 | 使用场景。 | FastBuy |
GpuDriverType | string | 否 | GPU 驱动类型。 枚举值:
| T4 |
返回参数
示例
正常返回示例
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"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2025-01-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-07-19 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-06-10 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-27 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-03-17 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-01-05 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-01-20 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2021-10-28 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2021-10-28 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2021-08-05 | 新增 OpenAPI | 查看变更详情 |