All Products
Search
Document Center

Elastic Desktop Service:GetDesktopGroupDetail

Last Updated:Mar 22, 2023

Queries the details of a desktop group.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the desktop group.

cn-hangzhou
DesktopGroupIdstringYes

The ID of the desktop group.

dg-2i8qxpv6t1a03****

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request.

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

The information about the desktop group.

Statusinteger

The status of the desktop group.

Enumeration Value:
  • 0
  • 1
  • 2
1
CreationTimestring

The time when the desktop group was created.

2020-11-06T08:28Z
PayTypestring

The billing method of the desktop group.

Enumeration Value:
  • PostPaid
  • PrePaid
PrePaid
ResetTypeinteger

Indicates which type of the disk used by cloud desktops in the desktop group is reset.

Enumeration Value:
  • 0
  • 1
  • 2
  • 3
0
LoadPolicyinteger

The load balancing policy of the multi-session desktop group.

Enumeration Value:
  • 0
  • 1
0
PolicyGroupNamestring

The name of the security policy group.

test
Creatorstring

The user who creates the desktop group.

155177335370****
MaxDesktopsCountinteger

The maximum number of cloud desktops that the desktop group can contain.

10
AllowAutoSetupinteger

Indicates whether the desktop group enables auto scale-out.

1
ResTypeinteger

The type of the resource. Currently, only Elastic Compute Service (ECS) instances are supported.

Enumeration Value:
  • 0
0
SystemDiskSizeinteger

The size of the system disk.

80
PolicyGroupIdstring

The ID of the security policy group.

pg-9cktlowtxfl6****
OwnBundleIdstring

The ID of the desktop template.

b-1se9fb37r5tfq****
GpuCountfloat

The number of vGPUs.

4
AllowBufferCountinteger

The number of reserved cloud desktops in the desktop group.

1
Memorylong

The memory size.

4096
GpuSpecstring

The GPU specifications.

NVIDIA T4
DirectoryIdstring

The ID of the directory, which is the same as the ID of the workspace.

cn-hangzhou+dir-363353****
OwnBundleNamestring

The name of the desktop template.

BundleDemo
DataDiskCategorystring

The category of the data disk.

cloud_essd
DesktopGroupNamestring

The name of the desktop group.

DesktopGroupDemo
BindAmountinteger

The number of sessions allowed for each cloud desktop in the multi-session desktop group.

1
OwnTypeinteger

The type of the desktop group.

Enumeration Value:
  • 0
  • 1
0
SystemDiskCategorystring

The category of the system disk.

cloud_essd
OfficeSiteIdstring

The ID of the workspace.

cn-hangzhou+dir-990541****
KeepDurationlong

The retention period of a cloud desktop in the desktop group after the cloud desktop is disconnected. Unit: milliseconds.

180000
MinDesktopsCountinteger

The minimum number of desktops that the desktop group must retain.

1
DataDiskSizestring

The size of the data disk.

80
DesktopGroupIdstring

The ID of the desktop group.

dg-3uiojcc0j4kh7****
OfficeSiteNamestring

The name of the workspace.

test
DirectoryTypestring

The type of the directory.

SIMPLE
Cpuinteger

The number of vCPUs.

4
ExpiredTimestring

The time when the desktop group expires.

2021-12-31T15:59Z
Commentsstring

The remarks on the desktop group.

for students
OfficeSiteTypestring

The type of the workspace.

SIMPLE
TimerInfosarray

The list of scheduled time for desktop group tasks.

object

The time when the desktop group task is scheduled to run.

Statusinteger

The status of the scheduled task.

Enumeration Value:
  • 1
  • 2
  • 3
1
CronExpressionstring

The CRON expression.

0 58 11 ? * 2
TimerTypeinteger

The type of the scheduled task.

Enumeration Value:
  • 1
  • 2
  • 3
  • 4
1
Forcedboolean

Indicates whether the scheduled task is forcibly executed.

false
RatioThresholdfloat

The session usage threshold for the multi-session desktop group that has an auto scaling policy in effect.

0.6
ConnectDurationlong

The maximum duration of the session. Unit: milliseconds.

60000
IdleDisconnectDurationlong

The maximum duration of the idle session. Unit: milliseconds.

900000
Versionlong

The version number of the desktop group.

1
StopDurationlong

The period of time before the idle cloud desktop enters the Stopped state. When the specified period of time is reached, the idle cloud desktop automatically enters the Stopped state. If an end user connects to a cloud desktop that is in the Stopped state, the cloud desktop automatically restarts. Unit: milliseconds.

180000
ProfileFollowSwitchboolean

Indicates whether data roaming is enabled.

true
NasFileSystemIDstring

The ID of the Apsara File Storage NAS (NAS) file system.

0783b4****
NasFileSystemNamestring

The name of the NAS file system.

abcd
TimingStrategyInfostring

The information about the scheduled application.

abcd
ScaleTimerInfosarray

The details of the scheduled task.

object
Typestring

The type of the scheduled task. Valid values:

Enumeration Value:
  • drop
  • normal
  • peak
  • rise
rise
Cronstring

The type of the CRON expression that is specified for the scheduled task.

0 0 0 * * ?
LoadPolicyinteger

The load balancing policy for the multi-session desktop group.

1
BuyResAmountinteger

The number of purchased cloud desktops during the scaling event. Valid values: 0 to 200.

5
MinResAmountinteger

The minimum number of cloud desktops. Valid values: 0 to 200.

1
MaxResAmountinteger

The maximum number of cloud desktops that the system can scale. Valid values: 0 to 200.

100
KeepDurationlong

The retention period of a cloud desktop in the desktop group after the cloud desktop is disconnected. Unit: milliseconds.

600000
RatioThresholdfloat

The threshold for the ratio of connected sessions. This parameter is the condition that triggers auto scaling in a multi-session desktop group. Ratio of connected sessions = Number of connected sessions/(Total number of cloud desktops x Maximum number of sessions allowed for each cloud desktop) x 100%. When the specified threshold is reached, new cloud desktops are automatically created. If the specified threshold is not reached, idle cloud desktops are released.

0.5
PolicyGroupIdsarray

The ID of the policy with which the desktop group is associated.

string

The ID of the policy with which the desktop group is associated.

pd-abcd***
PolicyGroupNamesarray

The name of the policy.

string

The name of the policy.

abcd
BuyDesktopsCountinteger

The number of purchased cloud desktops. Valid values: 0 to 200.

5
ImageIdstring

The IDs of the images.

m-4zfb6zj728hhr****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1B5268CE-5EB3-545F-9F38-A8BCF710****",
  "Desktops": {
    "Status": 1,
    "CreationTime": "2020-11-06T08:28Z",
    "PayType": "PrePaid",
    "ResetType": 0,
    "LoadPolicy": 0,
    "PolicyGroupName": "test",
    "Creator": "155177335370****",
    "MaxDesktopsCount": 10,
    "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": "DesktopGroupDemo",
    "BindAmount": 1,
    "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,
    "ExpiredTime": "2021-12-31T15:59Z",
    "Comments": "for students",
    "OfficeSiteType": "SIMPLE",
    "TimerInfos": [
      {
        "Status": 1,
        "CronExpression": "0 58 11 ? * 2",
        "TimerType": 1,
        "Forced": false
      }
    ],
    "RatioThreshold": 0.6,
    "ConnectDuration": 60000,
    "IdleDisconnectDuration": 900000,
    "Version": 1,
    "StopDuration": 180000,
    "ProfileFollowSwitch": true,
    "NasFileSystemID": "0783b4****",
    "NasFileSystemName": "abcd",
    "TimingStrategyInfo": "abcd",
    "ScaleTimerInfos": [
      {
        "Type": "rise",
        "Cron": "0 0 0 * * ? ",
        "LoadPolicy": 1,
        "BuyResAmount": 5,
        "MinResAmount": 1,
        "MaxResAmount": 100,
        "KeepDuration": 600000,
        "RatioThreshold": 0.5
      }
    ],
    "PolicyGroupIds": [
      "pd-abcd***"
    ],
    "PolicyGroupNames": [
      "abcd"
    ],
    "BuyDesktopsCount": 5,
    "ImageId": "m-4zfb6zj728hhr****"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2021-11-04The response structure of the API operation changes.
Change itemChange content
Output ParametersThe response structure of the API operation changes.