All Products
Search

This Product

    Elastic Desktop Service:DescribeDesktopsInGroup

    Document Center

    Elastic Desktop Service:DescribeDesktopsInGroup

    Last Updated:Jun 11, 2026

    Find cloud computers in a shared cloud computer by billing method.

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

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. You can call DescribeRegions to query the regions supported by Elastic Desktop Service.

    cn-hangzhou
    DesktopGroupId

    string

    Yes

    The ID of the computer pool.

    dg-2i8qxpv6t1a03****
    PayType

    string

    No

    The billing method.

    Valid values:

    • PostPaid :

      pay-as-you-go

    • PrePaid :

      subscription

    PrePaid
    MaxResults

    integer

    No

    The maximum number of entries to return on a single page.

    • Maximum value: 100.

    • Default value: 10.

    10
    NextToken

    string

    No

    The token that is used to start the next query. If this parameter is empty, all results are returned.

    caeba0bbb2be03f84eb48b699f0a4883
    IgnoreDeleted

    boolean

    No

    Specifies whether to return deleted desktops.

    Valid values:

    • true :

      Returns deleted desktops. (Default)

    • false :

      Does not return deleted desktops.

    true
    CustomStartTimePeriod

    integer

    No

    CustomEndTimePeriod

    integer

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    PostPaidDesktopsCount

    integer

    The total number of pay-as-you-go cloud desktops.

    10
    NextToken

    string

    The token to retrieve the next page of results. If this parameter is not returned, all results have been retrieved.

    caeba0bbb2be03f84eb48b699f0a4883
    PaidDesktopsCount

    integer

    The total number of subscription cloud desktops.

    10
    RequestId

    string

    The request ID.

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

    integer

    The total billed amount for the pay-as-you-go cloud desktops.

    10000
    PaidDesktops

    array<object>

    A list of subscription cloud desktops.

    object

    The details of a subscription cloud desktop.

    EndUserId

    string

    The ID of the authorized end user.

    alice
    DesktopStatus

    string

    The status of the cloud desktop.

    Valid values:

    • Stopped :

      Stopped

    • Starting :

      Starting

    • Rebuilding :

      Rebuilding

    • Running :

      Running

    • Stopping :

      Stopping

    • Expired :

      Expired

    • Deleted :

      Deleted

    • Pending :

      Pending

    Running
    DesktopName

    string

    The name of the cloud desktop.

    DemoComputer
    ConnectionStatus

    string

    The connection status of the cloud desktop.

    Valid values:

    • Unknown :

      Unknown

    • Connected :

      Connected

    • Disconnected :

      Disconnected

    Connected
    DesktopId

    string

    The ID of the cloud desktop.

    ud-7ftf5b6yu77b0****
    EndUserName

    string

    The name of the authorized end user.

    alice
    ManagementFlag

    string

    The management flag.

    Valid values:

    • Updating :

      Updating

    • NoFlag :

      No flag

    NoFlag
    EndUserIds

    array

    The IDs of end users connected to the cloud desktop. If no end user is connected, the array is empty.

    string

    The end user ID.

    alice
    EndUserNames

    array

    The usernames of end users connected to the cloud desktop. If no end user is connected, the array is empty.

    string

    The end user name.

    alice
    ResetTime

    string

    The time when the cloud desktop was last reset.

    2021-03-03 08:48:08
    ImageId

    string

    The image ID.

    m-hn5v2mmk0****
    ImageName

    string

    The image name.

    Win10_ZC
    SystemDiskSize

    integer

    The size of the system disk, in GiB.

    80
    OsType

    string

    The type of the operating system.

    Valid values:

    • Linux :

      Linux

    • Windows :

      Windows

    Windows
    GpuDriverVersion

    string

    The GPU driver version.

    1.0
    DiskType

    string

    The disk type.

    Valid values:

    • SYSTEM :

      system disk

    • DATA :

      data disk

    SYSTEM
    ManagementFlags

    array

    The management flags.

    string

    The management flag.

    Valid values:

    • Updating :

      Updating

    • NoFlag :

      No flag

    NoFlag
    MemberEniIp

    string

    The IP address of the secondary elastic network interface of the instance.

    192.168.XX.XX
    PrimaryEniIp

    string

    The IP address of the primary network interface of the instance.

    192.168.XX.XX
    ProtocolType

    string

    The session protocol.

    Valid values:

    • HDX :

      High-Definition Experience (HDX) protocol

    • ASP :

      Adaptive Streaming Protocol (ASP), a proprietary protocol developed by Alibaba Cloud

    ASP
    FotaVersion

    string

    The image version.

    0.1.0-R-20220914.17****
    ExpiredTime

    string

    The expiration time of the subscription cloud desktop.

    PostPaidDesktops

    array<object>

    A list of pay-as-you-go cloud desktops.

    object

    The details of a pay-as-you-go cloud desktop.

    CreateDuration

    string

    The retention period of the cloud desktop, in milliseconds.

    4153958447
    EndUserId

    string

    The ID of the authorized end user.

    alice
    DesktopStatus

    string

    The status of the cloud desktop.

    Valid values:

    • Stopped :

      Stopped

    • Starting :

      Starting

    • Rebuilding :

      Rebuilding

    • Running :

      Running

    • Stopping :

      Stopping

    • Expired :

      Expired

    • Deleted :

      Deleted

    • Pending :

      Pending

    Stopped
    CreateTime

    string

    The creation time of the cloud desktop.

    2022-01-21T06:34:57Z
    ReleaseTime

    string

    The release time of the cloud desktop.

    2022-01-21T16:34:57Z
    DesktopName

    string

    The name of the cloud desktop.

    DemoComputer
    ConnectionStatus

    string

    The connection status of the cloud desktop.

    Valid values:

    • Unknown :

      Unknown

    • Connected :

      Connected

    • Disconnected :

      Disconnected

    Connected
    DesktopId

    string

    The ID of the cloud desktop.

    ud-2i8qxpv6t1a07****
    EndUserName

    string

    The name of the authorized end user.

    alice
    ManagementFlag

    string

    The management flag.

    Valid values:

    • Updating :

      Updating

    • NoFlag :

      No flag

    NoFlag
    EndUserIds

    array

    The IDs of end users connected to the cloud desktop. If no end user is connected, the array is empty.

    string

    The end user ID.

    alice
    EndUserNames

    array

    The usernames of end users connected to the cloud desktop. If no end user is connected, the array is empty.

    string

    The end user name.

    alice
    ResetTime

    string

    The time when the cloud desktop was last reset.

    2021-03-03 08:48:08
    ImageId

    string

    The image ID.

    m-hn5v2mmk0****
    ImageName

    string

    The image name.

    Win10_ZC
    SystemDiskSize

    integer

    The size of the system disk, in GiB.

    80
    OsType

    string

    The type of the operating system.

    Valid values:

    • Linux :

      Linux

    • Windows :

      Windows

    Windows
    GpuDriverVersion

    string

    The GPU driver version.

    1.0
    DiskType

    string

    The disk type.

    Valid values:

    • SYSTEM :

      system disk

    • DATA :

      data disk

    SYSTEM
    ManagementFlags

    array

    The management flags.

    string

    The management flag.

    Valid values:

    • Updating :

      Updating

    • NoFlag :

      No flag

    NoFlag
    MemberEniIp

    string

    The IP address of the secondary elastic network interface of the instance.

    192.168.XX.XX
    PrimaryEniIp

    string

    The IP address of the primary network interface of the instance.

    192.168.XX.XX
    ProtocolType

    string

    The session protocol.

    Valid values:

    • HDX :

      High-Definition Experience (HDX) protocol

    • ASP :

      Adaptive Streaming Protocol (ASP), a proprietary protocol developed by Alibaba Cloud

    HDX
    FotaVersion

    string

    The image version.

    0.1.0-R-20220914.17****
    OnlinePrePaidDesktopsCount

    integer

    The number of connected subscription cloud desktops.

    100
    RunningPrePaidDesktopsCount

    integer

    The number of running subscription cloud desktops.

    100
    StopedPrePaidDesktopsCount

    integer

    Deprecated. This parameter is misspelled. Use StoppedPrePaidDesktopsCount instead.

    100
    StoppedPrePaidDesktopsCount

    integer

    The number of stopped subscription cloud desktops.

    100

    Examples

    Success response

    JSON format

    {
  "PostPaidDesktopsCount": 10,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PaidDesktopsCount": 10,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "PostPaidDesktopsTotalAmount": 10000,
  "PaidDesktops": [
    {
      "EndUserId": "alice",
      "DesktopStatus": "Running",
      "DesktopName": "DemoComputer",
      "ConnectionStatus": "Connected",
      "DesktopId": "ud-7ftf5b6yu77b0****",
      "EndUserName": "alice",
      "ManagementFlag": "NoFlag",
      "EndUserIds": [
        "alice"
      ],
      "EndUserNames": [
        "alice"
      ],
      "ResetTime": "2021-03-03 08:48:08",
      "ImageId": "m-hn5v2mmk0****",
      "ImageName": "Win10_ZC",
      "SystemDiskSize": 80,
      "OsType": "Windows",
      "GpuDriverVersion": "1.0",
      "DiskType": "SYSTEM",
      "ManagementFlags": [
        "NoFlag"
      ],
      "MemberEniIp": "192.168.XX.XX",
      "PrimaryEniIp": "192.168.XX.XX",
      "ProtocolType": "ASP",
      "FotaVersion": "0.1.0-R-20220914.17****",
      "ExpiredTime": ""
    }
  ],
  "PostPaidDesktops": [
    {
      "CreateDuration": "4153958447",
      "EndUserId": "alice",
      "DesktopStatus": "Stopped",
      "CreateTime": "2022-01-21T06:34:57Z",
      "ReleaseTime": "2022-01-21T16:34:57Z",
      "DesktopName": "DemoComputer",
      "ConnectionStatus": "Connected",
      "DesktopId": "ud-2i8qxpv6t1a07****",
      "EndUserName": "alice",
      "ManagementFlag": "NoFlag",
      "EndUserIds": [
        "alice"
      ],
      "EndUserNames": [
        "alice"
      ],
      "ResetTime": "2021-03-03 08:48:08",
      "ImageId": "m-hn5v2mmk0****",
      "ImageName": "Win10_ZC",
      "SystemDiskSize": 80,
      "OsType": "Windows",
      "GpuDriverVersion": "1.0",
      "DiskType": "SYSTEM",
      "ManagementFlags": [
        "NoFlag"
      ],
      "MemberEniIp": "192.168.XX.XX",
      "PrimaryEniIp": "192.168.XX.XX",
      "ProtocolType": "HDX",
      "FotaVersion": "0.1.0-R-20220914.17****"
    }
  ],
  "OnlinePrePaidDesktopsCount": 100,
  "RunningPrePaidDesktopsCount": 100,
  "StopedPrePaidDesktopsCount": 100,
  "StoppedPrePaidDesktopsCount": 100
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.