All Products
Search

This Product

    Elastic Desktop Service:DescribeBundles

    Document Center

    Elastic Desktop Service:DescribeBundles

    Last Updated:Jun 11, 2026

    Queries the details of cloud computer templates.

    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:DescribeBundles

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. You can call the operation to query the regions supported by Elastic Desktop Service (EDS).

    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

    number

    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 computer pool.

    Valid values:

    • true :

      Belongs to a computer pool.

    • false :

      (Default) Does not belong to a computer pool.

    false
    ProtocolType

    string

    No

    The protocol type.

    Valid values:

    • HDX :

      High-Definition Experience (HDX) protocol

    • ASP :

      (Recommended) In-house Adaptive Streaming Protocol (ASP)

    ASP
    BundleId

    array

    No

    The IDs of the cloud computer templates. You can specify 1 to 100 IDs.

    bundle_ecd_graphics.2xlarge_s15d15_win2019

    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

    Note

    This parameter is not available for public use.

    example
    SelectedBundle

    boolean

    No

    The desktop template that is selected based on specific criteria.

    true
    SessionType

    string

    No

    The type of the session.

    Valid values:

    • SingleSession :

      Single session

    • MultipleSession :

      Multiple sessions

    SingleSession
    ImageId

    array

    No

    The image IDs.

    string

    No

    The image ID.

    m-7by8d2m4kiicz****
    OsType

    string

    No

    The type of the OS.

    Valid values:

    • Linux :

      Linux

    • Windows :

      Windows

    Windows
    Scope

    string

    No

    The scenario to use the image.

    FastBuy
    GpuDriverType

    string

    No

    The GPU driver type.

    Valid values:

    • T4 :

      T4

    • A10 :

      A10

    • G28 :

      G28

    • G39 :

      G39

    T4

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    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 cloud computer templates.

    array<object>

    The cloud computer template.

    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 :

      Linux

    • Windows :

      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 protocol

    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.

    Valid values:

    • en-US :

      English

    • zh-HK :

      Chinese, Traditional (Hong Kong, China)

    • zh-CN :

      Simplified Chinese

    • ja-JP :

      Japanese

    en-US
    BundleName

    string

    The name of the cloud computer template.

    Advanced graphics with Windows 2019
    Disks

    array<object>

    Details of the disks.

    object

    Details of the disk.

    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 :

      PL1

    • PL0 :

      PL0

    • PL3 :

      PL3

    • PL2 :

      PL2

    PL0
    DesktopTypeAttribute

    object

    The details of the cloud computer instance type.

    CpuCount

    integer

    The number of vCPUs.

    10
    GpuCount

    number

    The number of GPUs.

    0.5
    GpuSpec

    string

    The GPU type.

    NVIDIA T4
    MemorySize

    integer

    The memory size. Unit: MiB.

    4096
    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 :

      Ubuntu

    • Windows Server 2022 :

      Windows Server 2022

    • UOS :

      UOS

    • CentOS :

      CentOS

    • Windows Server 2019 :

      Windows Server 2019

    • Windows Server 2016 :

      Windows Server 2016

    Windows Server 2019
    ImageStatus

    string

    The status of the image.

    Available
    SystemDiskCategory

    string

    The category of the system disk.

    Valid values:

    • cloud_efficiency :

      The ultra disk.

    • cloud_auto :

      The standard SSD.

    • cloud_essd :

      The Enterprise SSD (ESSD). Take note that only specific cloud computer types support ESSDs.

    cloud_efficiency
    DataDiskCategory

    string

    The category of the data disk.

    Valid values:

    • cloud_efficiency :

      The ultra disk.

    • cloud_auto :

      The standard SSD.

    • cloud_essd :

      The ESSD. Take note that only specific cloud computer types support ESSDs.

    cloud_efficiency

    Examples

    Success response

    JSON format

    {
  "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": 4096
      },
      "DesktopTypeFamily": "eds.general",
      "CreationTime": "2021-09-30T06:09Z",
      "SessionType": "0",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "Platform": "Windows Server 2019",
      "ImageStatus": "Available",
      "SystemDiskCategory": "cloud_efficiency",
      "DataDiskCategory": "cloud_efficiency"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.