DescribeBundles - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the details of cloud computer templates.

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.

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
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
NextToken	string	No	The token that is used to start the next query.	caeba0bbb2be03f84eb48b699f0a4883
BundleType	string	No	The type of the cloud computer template. Valid values: SYSTEM: system template CUSTOM: custom template	SYSTEM
DesktopTypeFamily	string	No	The instance family of the cloud computers. Valid values: eds.graphics: graphical instance families eds.hf: instance families with high clock speeds eds.general: general-purpose instance families	eds.general
CpuCount	integer	No	The number of vCPUs contained in the cloud computer instance type.	2
MemorySize	integer	No	The memory size of the cloud computer instance type. Unit: GiB.	4
GpuCount	float	No	The number of GPUs contained in the cloud computer instance type.	1
CheckStock	boolean	No	Specifies whether to query the inventory status of the cloud computer instance type.	true
FromDesktopGroup	boolean	No	Specifies whether the cloud computers in the template belong to a cloud computer pool. Valid values: true false	false
ProtocolType	string	No	The protocol type. Valid values: HDX: High-definition Experience (HDX) protocol ASP: in-house Adaptive Streaming Protocol (ASP) (recommend)	ASP
BundleId	array	No	The IDs of the cloud computer templates. You can specify 1 to 100 IDs.
	string	No	The ID of a cloud computer template.	bundle_ecd_graphics.2xlarge_s15d15_win2019
SupportMultiSession	boolean	No	Specifies whether to return multi-session cloud computer templates. Default value: false.	false
VolumeEncryptionEnabled	boolean	No	Specifies whether to enable disk encryption.	false
FotaChannel	string	No	This parameter is now in invitational preview and not publicly available.	This parameter is now in invitational preview and unavailable.
SelectedBundle	boolean	No	The desktop template that is selected based on specific criteria.	true
SessionType	string	No	The type of the session. Enumeration Value: SingleSession MultipleSession	SingleSession
ImageId	array	No	The image ID.
	string	No	The image ID.	m-7by8d2m4kiiczgd69
OsType	string	No	The type of the OS. Valid values: Linux Windows	Windows
Scope	string	No	The scenario to use the image.	FastBuy

Response parameters

Parameter	Type	Description	Example
	object	Schema of response.
NextToken	string	The token that is used for the next query. If this parameter is empty, all results have been returned.	AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8
RequestId	string	The ID of the request.	BCC854D8-5D1E-46D3-96EF-797A5DD36789
Bundles	array<object>	The details of the queried cloud computer templates.
Bundle	object
Description	string	The description of the cloud computer template.	test
BundleType	string	The type of the cloud computer template. Valid values: SYSTEM: system template CUSTOM: custom template	SYSTEM
OsType	string	The type of the OS. Valid values: Linux Windows	Windows
StockState	string	The inventory status of the cloud computer instance type. This parameter is returned only if you set the `CheckStock` parameter to `true`.	Sufficient
DesktopType	string	The instance type of the cloud computer.	ecd.graphics.2xlarge
ProtocolType	string	The protocol type. Valid values: HDX: HDX protocol ASP: in-house ASP	ASP
BundleId	string	The ID of the cloud computer template.	bundle_ecd_graphics.2xlarge_s15d15_win2019
ImageId	string	The image ID.	desktopimage-windows-server-2019-64-ch-vgpu
ImageName	string	The image name.	Windows server 2019 Chinese
Language	string	The OS language of the image.	en-US
BundleName	string	The name of the cloud computer template.	Advanced graphics with Windows 2019
Disks	array<object>	Details of the disks.
Disk	object
DiskType	string	The type of the disk. Valid values: SYSTEM: system disk DATA: data disk	SYSTEM
DiskSize	integer	The size of the disk. Unit: GiB.	150
DiskPerformanceLevel	string	The PL of the disk. Valid values: PL1 PL0 PL3 PL2	PL0
DesktopTypeAttribute	object	The details of the cloud computer instance type.
CpuCount	integer	The number of vCPUs.	10
GpuCount	float	The number of GPUs.	0.5
GpuSpec	string	The GPU type.	NVIDIA T4
MemorySize	integer	The memory size. Unit: MiB.	47104
DesktopTypeFamily	string	The instance family of the cloud computer. Valid values: eds.graphics: graphical instance family eds.hf: instance family with a high clock speed eds.general: general-purpose instance family	eds.general
CreationTime	string	The time when the cloud computer template was created.	2021-09-30T06:09Z
SessionType	string	The session type. Valid values: 0: single-session 1: multi-session	0
VolumeEncryptionEnabled	boolean	Indicates whether disk encryption is enabled.	false
VolumeEncryptionKey	string	The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled.	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
Platform	string	The OS. Valid values: Ubuntu Windows Server 2022 UOS CentOS Windows Server 2019 Windows Server 2016	Windows Server 2019
ImageStatus	string	The status of the image.	Available

Examples

Sample success responses

JSONformat

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8",
  "RequestId": "BCC854D8-5D1E-46D3-96EF-797A5DD36789",
  "Bundles": [
    {
      "Description": "test",
      "BundleType": "SYSTEM",
      "OsType": "Windows",
      "StockState": "Sufficient",
      "DesktopType": "ecd.graphics.2xlarge",
      "ProtocolType": "ASP",
      "BundleId": "bundle_ecd_graphics.2xlarge_s15d15_win2019",
      "ImageId": "desktopimage-windows-server-2019-64-ch-vgpu",
      "ImageName": "Windows server 2019 Chinese",
      "Language": "en-US",
      "BundleName": "Advanced graphics with Windows 2019",
      "Disks": [
        {
          "DiskType": "SYSTEM",
          "DiskSize": 150,
          "DiskPerformanceLevel": "PL0"
        }
      ],
      "DesktopTypeAttribute": {
        "CpuCount": 10,
        "GpuCount": 0.5,
        "GpuSpec": "NVIDIA T4",
        "MemorySize": 47104
      },
      "DesktopTypeFamily": "eds.general",
      "CreationTime": "2021-09-30T06:09Z",
      "SessionType": "0",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "Platform": "Windows Server 2019",
      "ImageStatus": "Available"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-19	The request parameters of the API has changed	View Change Details
2023-06-10	The request parameters of the API has changed	View Change Details
2023-04-27	The request parameters of the API has changed	View Change Details
2023-03-17	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-01-05	The request parameters of the API has changed	View Change Details
2022-01-20	The response structure of the API has changed	View Change Details
2021-10-28	The response structure of the API has changed	View Change Details
2021-10-28	The response structure of the API has changed	View Change Details
2021-08-05	Add Operation	View Change Details