All Products
Search

This Product

    Elastic Desktop Service:DescribeDesktopGroups

    Document Center

    Elastic Desktop Service:DescribeDesktopGroups

    Last Updated:Apr 02, 2026

    You can query the list and details of shared cloud desktops.

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

    list

    *All Resource

    *

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    RegionId

    string

    Yes

    The region ID. Call DescribeRegions to query the list of regions supported by Elastic Desktop Service (EDS).

    cn-hangzhou

    OfficeSiteId

    string

    No

    The ID of the office network to which the shared cloud computer belongs.

    cn-hangzhou+dir-467671****

    DesktopGroupName

    string

    No

    The name of the shared cloud computer to query. Fuzzy query is supported.

    CloudComputerPool01

    DesktopGroupId

    string

    No

    The ID of the shared cloud computer.

    dg-2i8qxpv6t1a03****

    Period

    integer

    No

    The subscription duration for a subscription shared cloud computer. The unit is specified by PeriodUnit.

    • If PeriodUnit is Month, valid values are:

      • 1

      • 2

      • 3

      • 6

    • If PeriodUnit is Year, valid values are:

      • 1

      • 2

      • 3

      • 4

      • 5

    1

    PeriodUnit

    string

    No

    The unit of the subscription duration for the subscription billing method.

    Valid values:

    • Month :

      Month

    • Year :

      Year

    Month

    MaxResults

    integer

    No

    The number of entries per page when performing a paged query. Maximum: 100. Default: 10.

    10

    NextToken

    string

    No

    The token for the next query. If `NextToken` is empty, no next page exists.

    caeba0bbb2be03f84eb48b699f0a4883

    PolicyGroupId

    string

    No

    The ID of the policy associated with the shared cloud computer.

    pg-53iyi2aar0nd6****

    Status

    integer

    No

    The status of the shared cloud computer.

    Valid values:

    • 0 :

      Unpaid

    • 1 :

      Normal

    • 2 :

      Overdue payment or expired

    1

    OwnType

    integer

    No

    The type of shared cloud computer.

    Note

    This parameter is not yet available.

    Valid values:

    • 0 :

      Single-session multi-desktop shared cloud computer

    • 1 :

      Multi-session multi-desktop shared cloud computer

    0

    EndUserIds

    array

    No

    The list of authorized user IDs for the shared cloud desktops.

    string

    No

    The authorized user ID of the shared desktop.

    alice

    ExcludedEndUserIds

    array

    No

    The list of authorized users to exclude.

    string

    No

    The authorized user to exclude.

    Tony

    ProtocolType

    string

    No

    The protocol type.

    Valid values:

    • HDX :

      HDX protocol

    • ASP :

      Alibaba Cloud's proprietary ASP protocol

    ASP

    ImageId

    array

    No

    The list of image IDs.

    string

    No

    The image ID.

    m-eeuo9qab4b0****

    BundleId

    array

    No

    The list of cloud desktop template IDs.

    string

    No

    The ID of the cloud desktop template.

    b-4w5nk44znm6****

    Tag

    array<object>

    No

    The list of tags. You can include 1 to 20 tags.

    object

    No

    The tag.

    Key

    string

    No

    The tag key. If you specify this parameter, it cannot be an empty string. It can contain up to 128 characters and cannot start with aliyun or acs:, nor can it contain http:// or https://.

    TestKey

    Value

    string

    No

    The tag value. It can be an empty string. It can contain up to 128 characters and cannot start with acs:, nor can it contain http:// or https://.

    TestValue

    MultiResource

    boolean

    No

    Indicates whether the shared cloud computer is of the multi-desktop shared type.

    Valid values:

    • true :

      Multi-desktop shared cloud computer

    • false :

      Single-desktop shared cloud computer

    true

    DesktopGroupIds

    array

    No

    The list of shared WUYING Workspace IDs.

    string

    No

    The ID of the shared desktop.

    dg-2i8qxpv6t1a03****

    DesktopType

    string

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    The collection of returned information.

    NextToken

    string

    The token for the next query.

    caeba0bbb2be03f84eb48b699f0a4883

    RequestId

    string

    The request ID.

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****

    DesktopGroups

    array<object>

    List of shared cloud desktops.

    array<object>

    Information about shared cloud desktops.

    CreateTime

    string

    The creation time.

    2022-02-17T14:51:07Z

    PayType

    string

    The billing method.

    Valid values:

    • PostPaid :

      Pay-as-you-go

    • PrePaid :

      Subscription

    PrePaid

    PolicyGroupName

    string

    The policy name associated with the shared WUYING Workspace.

    All enabled policy

    Creator

    string

    The Alibaba Cloud account ID of the creator.

    1007214305******

    MaxDesktopsCount

    integer

    • For pay-as-you-go shared cloud computers, this parameter indicates the maximum number of cloud computers that can be created.

    • For subscription shared cloud computers, this parameter indicates the sum of the initially purchased cloud computers (BuyDesktopsCount) and the number of cloud computers allowed for automatic creation.

    3

    SystemDiskSize

    integer

    The system disk capacity. Unit: GiB.

    80

    PolicyGroupId

    string

    The policy ID associated with the shared cloud computer.

    pg-53iyi2aar0nd6c8qj

    OwnBundleId

    string

    The ID of the desktop template.

    bundle_eds_general_4c8g_s8d5_win2019

    GpuCount

    number

    The number of GPU cores.

    1

    Memory

    integer

    The memory size. Unit: MiB.

    16384

    GpuSpec

    string

    The GPU video memory.

    16 GiB

    OwnBundleName

    string

    The name of the cloud desktop template.

    test

    DataDiskCategory

    string

    The user disk type.

    Valid values:

    • cloud_efficiency :

      Ultra disk

    • cloud_ssd :

      Standard SSD

    • cloud_essd :

      ESSD cloud disk

    cloud_ssd

    DesktopGroupName

    string

    The name of the shared desktop group.

    CloudComputerPool01

    SystemDiskCategory

    string

    The system disk type.

    Valid values:

    • cloud_efficiency :

      Ultra disk

    • cloud_ssd :

      Standard SSD

    • cloud_essd :

      ESSD cloud disk

    cloud_ssd

    OfficeSiteId

    string

    The name of the office network to which the shared WUYING Workspace belongs.

    cn-hangzhou+dir-467671****

    KeepDuration

    integer

    The duration to keep a session after disconnection. Unit: milliseconds. Valid values: 180000 (3 minutes) to 345600000 (4 days). A value of 0 indicates that the session is always kept.

    If a session disconnects, either actively by the user or due to other factors, the system calculates the retention period from the disconnection time. If the user does not re-establish a connection to the session within this period, the session logs off, and all unsaved data is destroyed. If the user successfully re-establishes a connection within this period, they can resume the original session and access data from before the disconnection.

    180000

    MinDesktopsCount

    integer

    • For pay-as-you-go shared WUYING Workspaces, this parameter indicates the minimum number of WUYING Workspaces to create.

    • For subscription shared WUYING Workspaces, this parameter is equivalent to BuyDesktopsCount, indicating the number of initially purchased WUYING Workspaces.

    1

    EndUserCount

    integer

    The number of authorized users for the shared cloud desktops.

    1

    DataDiskSize

    string

    The user disk capacity. Unit: GiB.

    50

    DesktopGroupId

    string

    The ID of the desktop group.

    dg-2i8qxpv6t1a03****

    OfficeSiteName

    string

    The ID of the office network to which the shared WUYING Workspace belongs.

    cn-hangzhou+os-c5cy7q578s8jc****

    Cpu

    integer

    The number of vCPU cores.

    4

    ExpiredTime

    string

    The expiration time of the subscription shared WUYING Workspace.

    2022-03-17T16:00:00Z

    Comments

    string

    The remarks.

    comment

    OfficeSiteType

    string

    The account system type of the office network.

    Valid values:

    • PERSONAL :

      Personal office network

    • SIMPLE :

      Convenience office network

    • AD_CONNECTOR :

      AD office network

    • RAM :

      RAM office network

    SIMPLE

    Status

    integer

    The status of the shared WUYING Workspace.

    Valid values:

    • 0 :

      Unpaid

    • 1 :

      Normal

    • 2 :

      Overdue payment or expired

    1

    ResetType

    integer

    The reset type of the shared cloud computer.

    Valid values:

    • 0 :

      Do not reset

    • 1 :

      Reset system disk only

    • 2 :

      Reset user disk only

    • 3 :

      Reset system disk and user disk

    0

    LoadPolicy

    integer

    The load balancing policy for multi-session multi-desktop shared WUYING Workspaces.

    Valid values:

    • 0 :

      Depth-first

    • 1 :

      Breadth-first

    1

    BindAmount

    integer

    The number of concurrent sessions allowed on each cloud computer in a multi-session shared desktop group.

    2

    OwnType

    integer

    The type of shared cloud computer.

    Valid values:

    • 0 :

      Single-session multi-desktop shared cloud computer

    • 1 :

      Multi-session multi-desktop shared cloud computer

    0

    ImageId

    string

    The image ID.

    m-gq15cq5ydlvwn****

    VolumeEncryptionEnabled

    boolean

    Indicates whether encryption is enabled.

    false

    VolumeEncryptionKey

    string

    The KMS key ID used for encrypted disks.

    e5409ada-xxxx-xxxx-xxxx-89e31e23e993

    RatioThreshold

    number

    The session utilization threshold, used as an auto-scaling trigger condition for multi-session multi-desktop shared WUYING Workspaces. The session utilization formula is:

    Session utilization = Number of bound sessions / (Total WUYING Workspace resources × Maximum number of sessions supported per WUYING Workspace) × 100%

    When session utilization reaches this threshold, new WUYING Workspaces are created. When it falls below this threshold, excess WUYING Workspaces are deleted.

    0.85

    ConnectDuration

    integer

    The maximum duration a session can remain connected. The session automatically disconnects when the connection duration reaches this value. Unit: milliseconds.

    3600000

    IdleDisconnectDuration

    integer

    After a user session establishes a connection, if there is no keyboard or mouse activity within this maximum duration, the session disconnects. Unit: milliseconds.

    90000

    Version

    integer

    The version number of the shared WUYING Workspace.

    2

    StopDuration

    integer

    The idle shutdown time. When a WUYING Workspace remains idle for this duration, it automatically shuts down. If a user connects after shutdown, it automatically starts up. Unit: milliseconds.

    900000

    ProtocolType

    string

    The protocol type.

    Valid values:

    • HDX :

      HDX protocol

    • ASP :

      Alibaba Cloud's proprietary ASP protocol

    ASP

    OsType

    string

    The operating system type.

    Valid values:

    • Linux :

      Linux

    • Windows :

      Windows

    Windows

    BuyDesktopsCount

    integer

    This parameter applies only to subscription shared WUYING Workspaces and indicates the number of initially purchased WUYING Workspaces. Valid values: 0 to 200.

    5

    DesktopCount

    integer

    The number of created cloud desktops.

    2

    DesktopType

    string

    The target cloud computer specification. Call DescribeDesktopTypes to query the cloud computer specification IDs supported.

    eds.enterprise_office.4c4g

    CountPerStatus

    array<object>

    A list of cloud computer counts by status.

    object

    The number of cloud desktops in each status.

    Status

    string

    The WUYING Workspace status.

    Valid values:

    • Stopped :

      Stopped

    • Starting :

      Starting

    • Rebuilding :

      Rebuilding

    • Running :

      Running

    • Stopping :

      Stopping

    • Expired :

      Expired

    • Deleted :

      Deleted

    • Pending :

      Pending

    Running

    Count

    integer

    Number of cloud desktops.

    10

    GpuDriverVersion

    string

    The GPU driver version.

    12

    SubnetId

    string

    The subnet ID.

    vsw-uf63bb6*****8gfytm

    Tags

    array<object>

    The list of tags.

    object

    The tag information.

    Key

    string

    The tag key.

    desktop_group_name

    Value

    string

    The tag value.

    ds-dq2mybjr23yw*****

    UserOuPath

    string

    The organizational unit path of the user.

    example.com

    IsLdap

    boolean

    UserGroupName

    string

    PolicyGroupIdList

    array

    string

    PolicyGroupNameList

    array

    string

    SimpleUserGroupId

    string

    AccountType

    string

    EntraDomainName

    string

    ExpiredTimes

    array

    string

    EnvType

    string

    EnvId

    string

    Examples

    Success response

    JSON format

    {
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "DesktopGroups": [
    {
      "CreateTime": "2022-02-17T14:51:07Z",
      "PayType": "PrePaid",
      "PolicyGroupName": "All enabled policy",
      "Creator": "1007214305******",
      "MaxDesktopsCount": 3,
      "SystemDiskSize": 80,
      "PolicyGroupId": "pg-53iyi2aar0nd6c8qj",
      "OwnBundleId": "bundle_eds_general_4c8g_s8d5_win2019",
      "GpuCount": 1,
      "Memory": 16384,
      "GpuSpec": "16 GiB",
      "OwnBundleName": "test",
      "DataDiskCategory": "cloud_ssd",
      "DesktopGroupName": "CloudComputerPool01",
      "SystemDiskCategory": "cloud_ssd",
      "OfficeSiteId": "cn-hangzhou+dir-467671****",
      "KeepDuration": 180000,
      "MinDesktopsCount": 1,
      "EndUserCount": 1,
      "DataDiskSize": "50",
      "DesktopGroupId": "dg-2i8qxpv6t1a03****",
      "OfficeSiteName": "cn-hangzhou+os-c5cy7q578s8jc****",
      "Cpu": 4,
      "ExpiredTime": "2022-03-17T16:00:00Z",
      "Comments": "comment",
      "OfficeSiteType": "SIMPLE",
      "Status": 1,
      "ResetType": 0,
      "LoadPolicy": 1,
      "BindAmount": 2,
      "OwnType": 0,
      "ImageId": "m-gq15cq5ydlvwn****",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "e5409ada-xxxx-xxxx-xxxx-89e31e23e993",
      "RatioThreshold": 0.85,
      "ConnectDuration": 3600000,
      "IdleDisconnectDuration": 90000,
      "Version": 2,
      "StopDuration": 900000,
      "ProtocolType": "ASP",
      "OsType": "Windows",
      "BuyDesktopsCount": 5,
      "DesktopCount": 2,
      "DesktopType": "eds.enterprise_office.4c4g",
      "CountPerStatus": [
        {
          "Status": "Running",
          "Count": 10
        }
      ],
      "GpuDriverVersion": "12",
      "SubnetId": "vsw-uf63bb6*****8gfytm",
      "Tags": [
        {
          "Key": "desktop_group_name",
          "Value": "ds-dq2mybjr23yw*****"
        }
      ],
      "UserOuPath": "example.com",
      "IsLdap": false,
      "UserGroupName": "",
      "PolicyGroupIdList": [
        ""
      ],
      "PolicyGroupNameList": [
        ""
      ],
      "SimpleUserGroupId": "",
      "AccountType": "",
      "EntraDomainName": "",
      "ExpiredTimes": [
        ""
      ],
      "EnvType": "",
      "EnvId": ""
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.