DescribeDesktopTypes - WUYING Workspace - Alibaba Cloud Documentation Center

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

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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: 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
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.advanced eds.graphics ecd.basic eds.hf ecd.graphics eds.general ecd.performance	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: `Public` Enumeration Value: Public: Public. SavingPlan: SavingPlan.	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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopTypes	object []	Details of cloud desktop types.
SystemDiskSize	string	The size of the system disk. Unit: GiB.	150
DesktopTypeId	string	The ID of the cloud desktop type.	ecd.graphics.xlarge
DataDiskSize	string	The size of the data disk. Unit: GiB.	150
CpuCount	string	The number of vCPUs.	2
GpuCount	float	The number of GPUs.	1
GpuSpec	string	The GPU memory.	16 GiB
InstanceTypeFamily	string	The family of the cloud desktop type.	ecd.graphics
MemorySize	string	The memory size. Unit: MiB.	23552
DesktopTypeStatus	string	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"
    }
  ]
}