Queries the details of cloud computer templates.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecd:DescribeBundles | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the regions supported by Elastic Desktop Service (EDS). | cn-hangzhou |
| MaxResults | integer | No | The number of entries to return on each page. Maximum value: 100. Default value: 10. | 10 |
| NextToken | string | No | The token that is used to start the next query. | caeba0bbb2be03f84eb48b699f0a4883 |
| BundleType | string | No | The type of the cloud computer template. Valid values:
| SYSTEM |
| DesktopTypeFamily | string | No | The instance family of the cloud computers. Valid values:
| eds.general |
| CpuCount | integer | No | The number of vCPUs contained in the cloud computer instance type. | 2 |
| MemorySize | integer | No | The memory size of the cloud computer instance type. Unit: GiB. | 4 |
| GpuCount | float | No | The number of GPUs contained in the cloud computer instance type. | 1 |
| CheckStock | boolean | No | Specifies whether to query the inventory status of the cloud computer instance type. | true |
| FromDesktopGroup | boolean | No | Specifies whether the cloud computers in the template belong to a cloud computer pool. Valid values:
| false |
| ProtocolType | string | No | The protocol type. Valid values:
| ASP |
| BundleId | array | No | The IDs of the cloud computer templates. You can specify 1 to 100 IDs. | |
| string | No | The ID of a cloud computer template. | bundle_ecd_graphics.2xlarge_s15d15_win2019 | |
| SupportMultiSession | boolean | No | Specifies whether to return multi-session cloud computer templates. Default value: false. | false |
| VolumeEncryptionEnabled | boolean | No | Specifies whether to enable disk encryption. | false |
| FotaChannel | string | No | Note
This parameter is not available for public use.
| This parameter is now in invitational preview and unavailable. |
| SelectedBundle | boolean | No | The desktop template that is selected based on specific criteria. | true |
| SessionType | string | No | The type of the session. Valide values:
| SingleSession |
| ImageId | array | No | The image IDs. | |
| string | No | The image ID. | m-7by8d2m4kiiczgd69 | |
| OsType | string | No | The type of the OS. Valid values:
| Windows |
| Scope | string | No | The scenario to use the image. | FastBuy |
| GpuDriverType | string | No | The GPU driver type. Valid values:
| T4 |
Response parameters
Examples
Sample success responses
JSONformat
{
"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": false,
"VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
"Platform": "Windows Server 2019",
"ImageStatus": "Available",
"SystemDiskCategory": "cloud_efficiency",
"DataDiskCategory": "cloud_efficiency"
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-01-15 | The response structure of the API has changed | View Change Details |
| 2024-07-19 | The request parameters of the API has changed | View Change Details |
| 2023-06-10 | The request parameters of the API has changed | View Change Details |
| 2023-04-27 | The request parameters of the API has changed | View Change Details |
| 2023-03-17 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-01-05 | The request parameters of the API has changed | View Change Details |
| 2022-01-20 | The response structure of the API has changed | View Change Details |
| 2021-10-28 | The response structure of the API has changed | View Change Details |
| 2021-10-28 | The response structure of the API has changed | View Change Details |
| 2021-08-05 | Add Operation | View Change Details |