Queries the instance types of cloud computers.
Operation description
When no values are specified for the InstanceTypeFamily and DesktopTypeId parameters for a cloud desktop, all types of cloud desktops are queried.
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:
- The required resource types are displayed in bold characters.
- 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:DescribeDesktopTypes | list |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| DesktopTypeId | string | No | The IDs of the instance types of cloud computers. Note
If the values of the InstanceTypeFamily and DesktopTypeId parameters are empty, all instance types of cloud computers are queried.
Valid values:
| ecd.graphics.xlarge |
| InstanceTypeFamily | string | No | The name of the instance family. Note
If the values of the InstanceTypeFamily and DesktopTypeId parameters are empty, all instance families of cloud computers are queried.
Valid values:
| ecd.graphics |
| CpuCount | integer | No | The number of vCPUs. | 2 |
| MemorySize | integer | No | The memory size. Unit: MiB. | 4 |
| GpuCount | float | No | The number of GPUs. | 1 |
| DesktopIdForModify | string | No | The ID of the cloud computer when you change instance types of cloud computers. If you specify this parameter, the information about whether the instance type is compatible with the cloud computer is included in the response. | ecd-gx2x1dhsmucyy**** |
| OrderType | string | No | The order type. | DOWNGRADE |
| AppliedScope | string | No | Applicable Scope of specifications. Default value: Enumeration Value:
| Public |
| DesktopGroupIdForModify | string | No | The ID of the cloud computer pool when you change instance types of cloud computers. If you specify this parameter, the information about whether the instance type is compatible with the cloud computer pool is included in the response. | dg-abcdefg**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"DesktopTypes": [
{
"SystemDiskSize": "150",
"DesktopTypeId": "ecd.graphics.xlarge",
"DataDiskSize": "150",
"CpuCount": "2",
"GpuCount": 1,
"GpuSpec": "16 GiB",
"InstanceTypeFamily": "ecd.graphics",
"MemorySize": "23552",
"DesktopTypeStatus": "SUFFICIENT"
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-19 | The request parameters of the API has changed | View Change Details |
| 2023-08-01 | The request parameters of the API has changed | View Change Details |
| 2022-05-31 | The response structure of the API has changed | View Change Details |
| 2021-12-22 | The request parameters of the API has changed | View Change Details |