Queries the details of desktop types.
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
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region. | cn-hangzhou |
DesktopTypeId | string | No | The ID of the cloud desktop type. Valid values:
| ecd.graphics.xlarge |
InstanceTypeFamily | string | No | The family of the cloud desktop type. Valid values:
| ecd.graphics |
CpuCount | integer | No | The number of vCPUs. | 2 |
MemorySize | integer | No | The memory size. Unit: GiB. | 4 |
GpuCount | float | No | The number of GPUs. | 1 |
DesktopIdForModify | string | No | When changing the configuration, enter the desktop ID that needs to be changed. The return value will increase the compatibility between the specifications and the desktop. | ecd-gx2x1dhsmucyy**** |
OrderType | string | No | The order type. | DOWNGRADE |
AppliedScope | string | No | Applicable Scope of specifications. Default value: Enumeration Value:
| Public |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 | ||||
---|---|---|---|---|---|---|
2023-08-01 | The request parameters of the API has changed | see changesets | ||||
| ||||||
2022-05-31 | The response structure of the API has changed | see changesets | ||||
| ||||||
2021-12-22 | The request parameters of the API has changed | see changesets | ||||
|