All Products
Search

This Product

    Elastic Desktop Service:GetDesktopGroupDetail

    Document Center

    Elastic Desktop Service:GetDesktopGroupDetail

    Last Updated:Apr 02, 2026

    Queries the details of a cloud computer share.

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

    get

    *All Resource

    *

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    RegionId

    string

    Yes

    Region ID. Call DescribeRegions to list regions that support Elastic Desktop Service (EDS).

    cn-hangzhou

    DesktopGroupId

    string

    Yes

    The ID of the cloud computer share.

    dg-2i8qxpv6t1a03****

    Response elements

    Element

    Type

    Description

    Example

    object

    Response data.

    RequestId

    string

    Request ID.

    1B5268CE-5EB3-545F-9F38-A8BCF710****

    Desktops

    object

    Information about the cloud computer share.

    Status

    integer

    Cloud computer share status.

    Valid values:

    • 0 :

      Unpaid

    • 1 :

      Normal

    • 2 :

      Overdue or expired

    1

    CreationTime

    string

    Creation time.

    2020-11-06T08:28Z

    PayType

    string

    Billing method.

    Valid values:

    • PostPaid :

      Pay-as-you-go

    • PrePaid :

      Subscription

    PrePaid

    ResetType

    integer

    Cloud computer reset type.

    Valid values:

    • 0 :

      No reset

    • 1 :

      Reset system disk only

    • 2 :

      Reset user disk only

    • 3 :

      Reset both system and user disks

    0

    LoadPolicy

    integer

    Traffic steering policy for multi-session, multi-cloud computer deployments.

    Valid values:

    • 0 :

      Depth-first

    • 1 :

      Breadth-first

    0

    PolicyGroupName

    string

    The name of the policy that is associated with the cloud computer share.

    All enabled policy

    Creator

    string

    Alibaba Cloud account ID of the creator.

    155177335370****

    MaxDesktopsCount

    integer

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

    • For subscription cloud computers, this is the sum of the initial purchase count (BuyDesktopsCount) and the number of cloud computers allowed for automatic creation.

    3

    AllowAutoSetup

    integer

    Whether to allow automatic creation of subscription cloud computers.

    Valid values:

    • 0 :

      Disabled

    • 1 :

      Enabled

    1

    ResType

    integer

    Resource type. Only Elastic Compute Service (ECS) is supported.

    Valid values:

    • 0 :

      ECS

    0

    SystemDiskSize

    integer

    System disk capacity in GiB.

    80

    PolicyGroupId

    string

    ID of the policy associated with the cloud computer share.

    pg-9cktlowtxfl6****

    OwnBundleId

    string

    Cloud computer template ID.

    b-1se9fb37r5tfq****

    GpuCount

    number

    Number of GPU cores.

    4

    AllowBufferCount

    integer

    Number of pre-started, idle cloud computers reserved for immediate connection. Applies only to pay-as-you-go cloud computers. Valid values:

    • 0: No reservation

    • N: Reserve N cloud computer(s) (1 ≤ N ≤ 100)

    1

    Memory

    integer

    Memory size in MiB.

    4096

    GpuSpec

    string

    GPU specification.

    NVIDIA T4

    DirectoryId

    string

    Directory ID (office network ID).

    cn-hangzhou+dir-363353****

    OwnBundleName

    string

    Cloud computer template name.

    BundleDemo

    DataDiskCategory

    string

    User disk type.

    cloud_essd

    DesktopGroupName

    string

    The name of the cloud computer share that you want to query.

    CloudComputerPool01

    BindAmount

    integer

    Maximum concurrent sessions per cloud computer in multi-session, multi-cloud computer deployments.

    2

    OwnType

    integer

    Cloud computer share type.

    Valid values:

    • 0 :

      Single-session cloud computer

    • 1 :

      Multi-session cloud computers

    0

    SystemDiskCategory

    string

    System disk type.

    cloud_essd

    OfficeSiteId

    string

    Office network ID.

    cn-hangzhou+dir-990541****

    KeepDuration

    integer

    Time to keep a disconnected session active. Unit: milliseconds. Valid range: 180000 (3 minutes) to 345600000 (4 days). A value of 0 means keep indefinitely.

    If a session disconnects due to user action or other reasons, the timer starts at disconnection. If no reconnection occurs within this duration, the session logs off and unsaved data is destroyed. If the user reconnects successfully within this duration, they resume the original session and access all previously saved data.

    180000

    MinDesktopsCount

    integer

    • For pay-as-you-go cloud computers, this is the minimum number of cloud computers to create.

    • For subscription cloud computers, this equals BuyDesktopsCount, the initial purchase count.

    1

    DataDiskSize

    string

    User disk capacity in GiB.

    80

    DesktopGroupId

    string

    Cloud computer share ID.

    dg-3uiojcc0j4kh7****

    OfficeSiteName

    string

    Name of the office network where the cloud computer share resides.

    test

    DirectoryType

    string

    Directory type.

    SIMPLE

    Cpu

    integer

    vCPU count.

    4

    Comments

    string

    Remarks.

    comment

    OfficeSiteType

    string

    Account system type of the office network.

    Valid values:

    • PERSONAL :

      Personal office network

    • SIMPLE :

      Simple office network

    • AD_CONNECTOR :

      Active Directory (AD) office network

    • RAM :

      RAM office network

    SIMPLE

    TimerInfos

    array<object>

    List of scheduled tasks.

    object

    The scheduled time.

    Status

    integer

    Status.

    Valid values:

    • 1 :

      Enabled

    • 2 :

      Disabled

    • 3 :

      Deleted

    1

    CronExpression

    string

    Cron expression.

    0 58 11 ? * 2

    TimerType

    integer

    Scheduled task type.

    Valid values:

    • 1 :

      Scheduled reset

    • 2 :

      Scheduled start

    • 3 :

      Scheduled stop

    • 4 :

      Scheduled restart

    1

    Forced

    boolean

    Whether to force execute this scheduled task.

    false

    RatioThreshold

    number

    Session occupancy threshold used to trigger auto scaling for multi-session, multi-cloud computer deployments. Session occupancy is calculated as:

    Session occupancy = (Bound sessions / (Total cloud computers × Max sessions per cloud computer)) × 100%

    When occupancy reaches this threshold, new cloud computers are created. When occupancy falls below this threshold, excess cloud computers are deleted.

    0.85

    ConnectDuration

    integer

    Maximum time a session remains connected. The session disconnects automatically when this duration is reached. Unit: milliseconds.

    3600000

    IdleDisconnectDuration

    integer

    Time after which an idle session disconnects. If no keyboard or mouse activity occurs during this period, the session disconnects. Unit: milliseconds.

    900000

    Version

    integer

    The version number of the cloud computer share.

    2

    StopDuration

    integer

    Idle shutdown time. The cloud computer shuts down automatically after being idle for this duration. If a user connects after shutdown, the cloud computer starts automatically. Unit: milliseconds.

    180000

    ProfileFollowSwitch

    boolean

    Whether to enable user profile roaming.

    false

    NasFileSystemID

    string

    NAS file system ID used for user profile roaming.

    0783b4****

    NasFileSystemName

    string

    NAS file system name used for user profile roaming.

    abcd

    TimingStrategyInfo

    string

    Scheduled application information.

    abcd

    ScaleTimerInfos

    array<object>

    Scheduled scaling task information.

    object

    Scheduled scaling task information.

    Type

    string

    Scheduled scaling task type.

    Valid values:

    • drop :

      Scale-down policy

    • normal :

      Normal policy

    • peak :

      Peak policy

    • rise :

      Scale-up policy

    rise

    Cron

    string

    Cron expression for the scheduled scaling task.

    0 0 0 * * ?

    LoadPolicy

    integer

    Traffic steering policy for multi-session, multi-cloud computer deployments.

    Valid values:

    • 0 :

      Depth-first

    • 1 :

      Breadth-first

    1

    BuyResAmount

    integer

    Scaling parameter: Number of cloud computers to buy. Valid values: 0 to 200.

    5

    MinResAmount

    integer

    Scaling parameter: Minimum number of cloud computers. Valid values: 0 to 200.

    1

    MaxResAmount

    integer

    Scaling parameter: Maximum number of cloud computers. Valid values: 0 to 200.

    100

    KeepDuration

    integer

    Time to keep a disconnected session active. Unit: milliseconds. Valid range: 180000 (3 minutes) to 345600000 (4 days). A value of 0 means keep indefinitely.

    If a session disconnects due to user action or other reasons, the timer starts at disconnection. If no reconnection occurs within this duration, the session logs off and unsaved data is destroyed. If the user reconnects successfully within this duration, they resume the original session and access all previously saved data.

    180000

    RatioThreshold

    number

    Session occupancy threshold used to trigger auto scaling for multi-session, multi-cloud computer deployments. Session occupancy is calculated as:

    Session occupancy = (Bound sessions / (Total cloud computers × Max sessions per cloud computer)) × 100%

    When occupancy reaches this threshold, new cloud computers are created. When occupancy falls below this threshold, excess cloud computers are deleted.

    0.85

    PolicyGroupIds

    array

    The IDs of the policies that are associated with the cloud computer share.

    string

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

    pd-abcd***

    PolicyGroupNames

    array

    A list of policy names associated with cloud computer share.

    string

    Policy names associated with the cloud computer share.

    All enabled policy

    BuyDesktopsCount

    integer

    Initial purchase count for subscription cloud computers. Valid values: 0 to 200.

    5

    ImageId

    string

    Image ID.

    m-4zfb6zj728hhr****

    ExpiredTime

    string

    Expiration time for subscription cloud computers.

    2021-12-31T15:59Z

    OsType

    string

    ProtocolType

    string

    ExpiredTimes

    array

    string

    EnvType

    string

    EnvId

    string

    Examples

    Success response

    JSON format

    {
  "RequestId": "1B5268CE-5EB3-545F-9F38-A8BCF710****",
  "Desktops": {
    "Status": 1,
    "CreationTime": "2020-11-06T08:28Z",
    "PayType": "PrePaid",
    "ResetType": 0,
    "LoadPolicy": 0,
    "PolicyGroupName": "All enabled policy",
    "Creator": "155177335370****",
    "MaxDesktopsCount": 3,
    "AllowAutoSetup": 1,
    "ResType": 0,
    "SystemDiskSize": 80,
    "PolicyGroupId": "pg-9cktlowtxfl6****",
    "OwnBundleId": "b-1se9fb37r5tfq****",
    "GpuCount": 4,
    "AllowBufferCount": 1,
    "Memory": 4096,
    "GpuSpec": "NVIDIA T4",
    "DirectoryId": "cn-hangzhou+dir-363353****",
    "OwnBundleName": "BundleDemo",
    "DataDiskCategory": "cloud_essd",
    "DesktopGroupName": "CloudComputerPool01\n",
    "BindAmount": 2,
    "OwnType": 0,
    "SystemDiskCategory": "cloud_essd",
    "OfficeSiteId": "cn-hangzhou+dir-990541****",
    "KeepDuration": 180000,
    "MinDesktopsCount": 1,
    "DataDiskSize": "80",
    "DesktopGroupId": "dg-3uiojcc0j4kh7****",
    "OfficeSiteName": "test",
    "DirectoryType": "SIMPLE",
    "Cpu": 4,
    "Comments": "comment",
    "OfficeSiteType": "SIMPLE",
    "TimerInfos": [
      {
        "Status": 1,
        "CronExpression": "0 58 11 ? * 2",
        "TimerType": 1,
        "Forced": false
      }
    ],
    "RatioThreshold": 0.85,
    "ConnectDuration": 3600000,
    "IdleDisconnectDuration": 900000,
    "Version": 2,
    "StopDuration": 180000,
    "ProfileFollowSwitch": false,
    "NasFileSystemID": "0783b4****",
    "NasFileSystemName": "abcd",
    "TimingStrategyInfo": "abcd",
    "ScaleTimerInfos": [
      {
        "Type": "rise",
        "Cron": "0 0 0 * * ? ",
        "LoadPolicy": 1,
        "BuyResAmount": 5,
        "MinResAmount": 1,
        "MaxResAmount": 100,
        "KeepDuration": 180000,
        "RatioThreshold": 0.85
      }
    ],
    "PolicyGroupIds": [
      "pd-abcd***"
    ],
    "PolicyGroupNames": [
      "All enabled policy"
    ],
    "BuyDesktopsCount": 5,
    "ImageId": "m-4zfb6zj728hhr****",
    "ExpiredTime": "2021-12-31T15:59Z",
    "OsType": "",
    "ProtocolType": "",
    "ExpiredTimes": [
      ""
    ],
    "EnvType": "",
    "EnvId": ""
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.