All Products
Search
Document Center

WUYING Workspace:DescribeDesktopTypes

Last Updated:Mar 26, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
DesktopTypeIdstringNo

The ID of the cloud desktop type. Valid values:

  • eds.graphics.16c1t4
  • eds.graphics.24c1t4
  • eds.hf.12c24g
  • eds.hf.8c16g
  • eds.hf.4c8g
  • eds.general.8c32g
  • eds.general.16c32g
  • eds.general.8c16g
  • eds.general.4c16g
  • eds.general.4c8g
  • eds.general.2c8g
  • eds.general.2c4g
  • eds.general.2c2g
  • ecd.graphics.xlarge
  • ecd.graphics.2xlarge
  • ecd.performance.2xlarge
  • ecd.advanced.xlarge
  • ecd.advanced.large
  • ecd.basic.large
  • ecd.basic.small
ecd.graphics.xlarge
InstanceTypeFamilystringNo

The family of the cloud desktop type. Valid values:

  • eds.graphics
  • eds.hf
  • eds.general
  • ecd.graphics
  • ecd.performance
  • ecd.advanced
  • ecd.basic
ecd.graphics
CpuCountintegerNo

The number of vCPUs.

2
MemorySizeintegerNo

The memory size. Unit: GiB.

4
GpuCountfloatNo

The number of GPUs.

1
DesktopIdForModifystringNo

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

The order type.

DOWNGRADE
AppliedScopestringNo

Applicable Scope of specifications. Default value: Public

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopTypesobject []

Details of cloud desktop types.

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
2023-08-01The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DesktopGroupIdForModify
2022-05-31The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2021-12-22The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AppliedScope