All Products
Search
Document Center

Elastic Desktop Service:DescribeDesktopTypes

Last Updated:Oct 17, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DesktopTypeIdstringNo

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:

  • eds.hf.4c8g

  • ecd.basic.large

  • ecd.advanced.large

  • ecd.basic.small

  • ecd.graphics.2xlarge

  • eds.hf.8c16g

  • eds.hf.12c24g

  • eds.general.8c16g

  • eds.general.16c32g

  • ecd.advanced.xlarge

  • eds.graphics.16c1t4

  • ecd.graphics.xlarge

  • ecd.performance.2xlarge

  • eds.general.8c32g

  • eds.general.2c2g

  • eds.general.2c4g

  • eds.graphics.24c1t4

  • eds.general.4c8g

  • eds.general.4c16g

  • eds.general.2c8g

ecd.graphics.xlarge
InstanceTypeFamilystringNo

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.advanced

  • eds.graphics

  • ecd.basic

  • eds.hf

  • ecd.graphics

  • eds.general

  • ecd.performance

ecd.graphics
CpuCountintegerNo

The number of vCPUs.

2
MemorySizeintegerNo

The memory size. Unit: MiB.

4
GpuCountfloatNo

The number of GPUs.

1
DesktopIdForModifystringNo

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****
OrderTypestringNo

The order type.

DOWNGRADE
AppliedScopestringNo

Applicable Scope of specifications. Default value: Public

Enumeration Value:
  • Public: Public.
  • SavingPlan: SavingPlan.
Public
DesktopGroupIdForModifystringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopTypesarray<object>

Details of cloud desktop types.

DesktopTypeobject
SystemDiskSizestring

The size of the system disk. Unit: GiB.

150
DesktopTypeIdstring

The ID of the cloud desktop type.

ecd.graphics.xlarge
DataDiskSizestring

The size of the data disk. Unit: GiB.

150
CpuCountstring

The number of vCPUs.

2
GpuCountfloat

The number of GPUs.

1
GpuSpecstring

The GPU memory.

16 GiB
InstanceTypeFamilystring

The family of the cloud desktop type.

ecd.graphics
MemorySizestring

The memory size. Unit: MiB.

23552
DesktopTypeStatusstring

The status of the cloud desktop type. If SUFFICIENT is returned, the number of cloud desktops of the type is sufficient.

SUFFICIENT

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 timeSummary of changesOperation
2024-09-27The request parameters of the API has changed. The response structure of the API has changedView Change Details
2024-07-19The request parameters of the API has changedView Change Details
2023-08-01The request parameters of the API has changedView Change Details
2022-05-31The response structure of the API has changedView Change Details
2021-12-22The request parameters of the API has changedView Change Details