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

Query Elastic Desktop Service (EDS) 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
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query available WUYING Workspace regions.	cn-hangzhou
DesktopTypeId	string	No	The instance type ID. 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	The instance type family. Note If you leave both the `InstanceTypeFamily` and `DesktopTypeId` parameters empty, the operation returns information about all available instance types. 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	The number of vCPUs. Note When the `InstanceTypeFamily` and `DesktopTypeId` parameters are both empty, information about all cloud desktop specifications is returned.	2
MemorySize	integer	No	The memory size, in MiB.	4096
GpuCount	number	No	The number of GPUs.	1
DesktopIdForModify	string	No	The ID of the cloud desktop for which to change the configuration. The response indicates which instance types are compatible with this cloud desktop.	ecd-gx2x1dhsmucyy****
OrderType	string	No	The type of configuration change. Valid values: DOWNGRADE : Configuration downgrade. UPGRADE : Configuration upgrade.	DOWNGRADE
AppliedScope	string	No	The scope of the instance type. Default value: `Public`. Valid values: Public : Resources that are available to all users. SavingPlan : Resources available to savings plan users.	Public
DesktopGroupIdForModify	string	No	The ID of the cloud desktop pool for which to change the configuration. The response indicates which instance types are compatible with this pool.	dg-abcdefg****
GpuDriverType	string	No	The type of the GPU driver. Valid values: T4 : T4 A10 : A10 G28 : G28 G39 : G39	A10
OrderBy	string	No	The property by which to sort the results. By default, results are sorted by creation time in descending order. Valid values: Memory : Sorts the results by memory size. Cpu : Sorts the results by vCPU count.	Memory
SortType	string	No	The sort order. Valid values: ASC : Ascending (default) DESC : Descending	ASC
Scope	string	No	The billing method of the instance type. Valid values: MonthPackage : Subscription FastBuy : Pay-as-you-go	FastBuy
DesktopTypeIdList	array	No	A list of instance type IDs.
	string	No	An instance type ID.	eds.enterprise.4c8g
SupportMinSessionCount	integer	No	The minimum number of concurrent sessions that an instance type must support. This parameter filters for multi-session instance types.	2
ZoneId	string	No	The number of concurrent sessions supported by the rule.	无
GpuMemory	integer	No	Note This parameter is for internal use only.
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 instance types.
	object	The details of the instance type.
SystemDiskSize	string	The system disk size. Unit: GiB.	150
DesktopTypeId	string	The instance type 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 GPUs.	1
GpuSpec	string	The GPU memory size, formatted as a string.	16 GiB
InstanceTypeFamily	string	The instance type family.	ecd.graphics
MemorySize	string	The memory size. Unit: MiB.	23552
DesktopTypeStatus	string	The availability status of the instance type. A value of `SUFFICIENT` indicates that the instance type is available for purchase.	SUFFICIENT
Scopes	array	The available purchase methods for the instance type.
	string	The purchase method for the instance type. Valid values: MonthPackage : monthly subscription FastBuy : On-demand	FastBuy
StockState	string	The inventory status. Valid values: Insufficient : Out of stock Sufficient : In stock	Sufficient
GpuMemory	integer	The GPU memory size in megabytes (MB). This parameter is returned only for GPU-accelerated cloud desktops.	2048
MaxSessionCount	integer	The number of concurrent sessions supported by the instance type.	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.