Query cloud computer instance types using DescribeDesktopTypes - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Queries the details of cloud computer specifications.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeDesktopTypes

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BusinessChannel	string	No	Region ID. Call DescribeRegions to get a list of regions that Elastic Desktop Service (EDS) supports.
RegionId	string	Yes	Type ID. Note If both the `InstanceTypeFamily` and `DesktopTypeId` parameters are empty, query information about all WUYING Workspace types.	cn-hangzhou
DesktopTypeId	string	No	Family name. Note If both the `InstanceTypeFamily` and `DesktopTypeId` parameters are empty, query information about all WUYING Workspace types. Valid values: eds.enterprise_office.4c8g : eds.enterprise_office.4c8g eds.hf.4c8g : eds.hf.4c8g ecd.basic.large : ecd.basic.large ecd.advanced.large : ecd.advanced.large eds.enterprise_office.8c16g : eds.enterprise_office.8c16g ecd.basic.small : ecd.basic.small ecd.graphics.2xlarge : ecd.graphics.2xlarge eds.hf.8c16g : eds.hf.8c16g eds.hf.12c24g : eds.hf.12c24g eds.general.8c16g : eds.general.8c16g eds.general.16c32g : eds.general.16c32g ecd.advanced.xlarge : ecd.advanced.xlarge eds.graphics.16c1t4 : eds.graphics.16c1t4 ecd.graphics.xlarge : ecd.graphics.xlarge ecd.performance.2xlarge : ecd.performance.2xlarge eds.general.8c32g : eds.general.8c32g eds.general.2c2g : eds.general.2c2g eds.general.2c4g : eds.general.2c4g eds.graphics.24c1t4 : eds.graphics.24c1t4 eds.general.4c8g : eds.general.4c8g eds.enterprise_office.2c4g : eds.enterprise_office.2c4g eds.general.4c16g : eds.general.4c16g eds.general.2c8g : eds.general.2c8g	ecd.graphics.xlarge
InstanceTypeFamily	string	No	vCPU count. Valid values: ecd.advanced : ecd.advanced eds.graphics : eds.graphics ecd.basic : ecd.basic eds.enterprise_office : eds.enterprise_office eds.hf : eds.hf ecd.graphics : ecd.graphics eds.general : eds.general ecd.performance : ecd.performance	ecd.graphics
CpuCount	integer	No	Memory size. Unit: MiB.	2
MemorySize	integer	No	GPU count.	4096
GpuCount	number	No	When upgrading or downgrading, enter the ID of the WUYING Workspace to upgrade or downgrade. The return value includes compatibility information between the type and the cloud computer.	1
DesktopIdForModify	string	No	Order type.	ecd-gx2x1dhsmucyy****
OrderType	string	No	Scope of the type. Default value: `Public`. Valid values: DOWNGRADE : Configuration downgrade. UPGRADE : Configuration upgrade.	DOWNGRADE
AppliedScope	string	No	When upgrading or downgrading, enter the ID of the cloud computer share to upgrade or downgrade. The return value includes compatibility information between the type and the shared cloud computers. Valid values: Public : Resources that are available to all users. SavingPlan : Resources available to savings plan users.	Public
DesktopGroupIdForModify	string	No	GPU driver type.	dg-abcdefg****
GpuDriverType	string	No	Sorting field. If not specified, sort by creation time in descending order. Valid values: T4 : T4 A10 : A10 G28 : G28 G39 : G39	A10
OrderBy	string	No	Sorting method. Valid values: Memory : Sorts the results by memory size. Cpu : Sorts the results by vCPU count.	Memory
SortType	string	No	Selling method of the type. Valid values: ASC : Ascending (default) DESC : Descending	ASC
Scope	string	No	List of type IDs. Valid values: MonthPackage : Subscription FastBuy : Pay-as-you-go	FastBuy
DesktopTypeIdList	array	No	Query the number of multi-sessions that the rule supports.
	string	No	An instance type ID.	eds.enterprise.4c8g
SupportMinSessionCount	integer	No	Note This parameter is not publicly available.	2
ZoneId	string	No	The GPU memory size. Unit: MB.	无
GpuMemory	integer	No
ScopeSet	array	No
	string	No
OfficeSiteId	string	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopTypes	array<object>	The details of the specifications.
	object	The details of the specification.
SystemDiskSize	string	The system disk size. Unit: GiB.	150
DesktopTypeId	string	The specification ID.	ecd.graphics.xlarge
DataDiskSize	string	The data disk size. Unit: GiB.	150
CpuCount	string	The number of vCPUs.	2
GpuCount	number	The number of GPU cores.	1
GpuSpec	string	The GPU memory.	16 GiB
InstanceTypeFamily	string	The specification family.	ecd.graphics
MemorySize	string	The memory size. Unit: MiB.	23552
DesktopTypeStatus	string	The status of the specification. If `SUFFICIENT` is returned, the resources for the specification are sufficient.	SUFFICIENT
Scopes	array	A list of purchase methods for the specification.
	string	The purchase method for the specification. Valid values: MonthPackage : Purchase a monthly package FastBuy : Quick Purchase	FastBuy
StockState	string	The inventory status. Valid values: Insufficient : No Inventory Sufficient : Sufficient Inventory	Sufficient
GpuMemory	integer	The GPU memory size. This parameter is returned only for GPU-accelerated workspaces. Unit: MB.	2048
MaxSessionCount	integer	The number of concurrent sessions supported by the specification.	4
Description	string
EnvType	string
EnvId	string

Examples

Success response

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",
      "Scopes": [
        "FastBuy"
      ],
      "StockState": "Sufficient",
      "GpuMemory": 2048,
      "MaxSessionCount": 4,
      "Description": "",
      "EnvType": "",
      "EnvId": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.