GetDesktopGroupDetail - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the information about a cloud computer share.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DesktopGroupId	string	Yes	The ID of the cloud computer share.	dg-2i8qxpv6t1a03****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	1B5268CE-5EB3-545F-9F38-A8BCF710****
Desktops	object	The cloud computers within the share.
Status	integer	The status of the cloud computer share. Valid values: 0: The cloud computer share is unpaid. 1: The cloud computer share is normal. 2: The cloud computer share expired, or your account has an overdue payment.	1
CreationTime	string	The time when the desktop group was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2020-11-06T08:28Z
PayType	string	The billing method. Valid values: PostPaid: pay-as-you-go. PrePaid: subscription.	PrePaid
ResetType	integer	The disk reset type of the cloud computer. Valid values: 0: does not reset disks. 1: resets only the system disk. 2: resets only the user disk. 3: resets the system disk and the user disk.	0
LoadPolicy	integer	The load balancing policy for the multi-session many-to-many share. Valid values: 0: depth-first. 1: breadth-first.	0
PolicyGroupName	string	The name of the applied policy.	test
Creator	string	The Alibaba Cloud account that creates the cloud computer pool.	155177335370****
MaxDesktopsCount	integer	The maximum number of cloud computers allowed in the pay-as-you-go cloud computer share.	10
AllowAutoSetup	integer	Specifies whether to enable batch-based automatic creation of cloud computers in the subscription cloud computer share. Valid values: 0: enables batch-based automatic creation of cloud computers. 1: disables batch-based automatic creation of cloud computers.	1
ResType	integer	The type of the resource. Only Elastic Compute Service (ECS) instances are supported. Valid value: 0: ECS	0
SystemDiskSize	integer	The system disk capacity. Unit: GiB.	80
PolicyGroupId	string	The ID of the applied policy.	pg-9cktlowtxfl6****
OwnBundleId	string	The ID of the cloud computer template.	b-1se9fb37r5tfq****
GpuCount	float	The number of vGPUs.	4
AllowBufferCount	integer	This parameter applies to pay-as-you-go cloud computer shares and specifies the number of standby cloud computers that can be reserved per cloud computer share. Valid values: 0: does not reserve any cloud computers. N: reserves N cloud computers (1≤ N ≤ 100).	1
Memory	long	The memory size. Unit: MiB.	4096
GpuSpec	string	The GPU specifications.	NVIDIA T4
DirectoryId	string	The ID of the directory or office network.	cn-hangzhou+dir-363353****
OwnBundleName	string	The name of the cloud computer template.	BundleDemo
DataDiskCategory	string	The category of the user disk.	cloud_essd
DesktopGroupName	string	The name of the cloud computer share.	DesktopGroupDemo
BindAmount	integer	The maximum number of concurrent sessions allowed per cloud computer within the multi-session many-to-many share.	1
OwnType	integer	The type of the cloud computer share. Valid values: 0: a one-to-many share. 1: a many-to-many share.	0
SystemDiskCategory	string	The category of the system disk.	cloud_essd
OfficeSiteId	string	The ID of the office network.	cn-hangzhou+dir-990541****
KeepDuration	long	The amount of time to retain a session after it is disconnected. Unit: milliseconds. Valid values: 180000 to 345600000. That is, the session can be retained for 3 to 5760 minutes (4 days). If you specify the value to 0, the session is permanently retained. When a session is disconnected, take note of the following situations: If an end user does not resume the session within the specified duration, the session is closed and all unsaved data is cleared. If the end user resumes the session within the specified duration, the end user can still access data of the session.	180000
MinDesktopsCount	integer	The number of cloud computers created in the initial batch within the subscription cloud computer share.	1
DataDiskSize	string	The user disk capacity. Unit: GiB.	80
DesktopGroupId	string	The ID of the cloud computer share.	dg-3uiojcc0j4kh7****
OfficeSiteName	string	The name of the office network in which the cloud computer resides.	test
DirectoryType	string	The type of the directory.	SIMPLE
Cpu	integer	The number of vCPUs.	4
ExpiredTime	string	The expiration date of the subscription cloud computer share.	2021-12-31T15:59Z
Comments	string	The remarks.	for students
OfficeSiteType	string	The office network type. Valid values: PERSONAL: individual office network SIMPLE: convenience office network AD_CONNECTOR: enterprise Active Directory (AD) office network RAM: Resource Access Management (RAM)-based office network	SIMPLE
TimerInfos	array<object>	The list of scheduled points in time for desktop group tasks.
TimerInfo	object	The time when the desktop group task is scheduled to run.
Status	integer	The status of the cloud computer pool. Valid values: 1: enabled 2: disabled 3: deleted	1
CronExpression	string	The cron expression.	0 58 11 ? * 2
TimerType	integer	The type of the scheduled task. Valid values: 1: scheduled reset 2: scheduled startup 3: scheduled stop 4: scheduled restart	1
Forced	boolean	Indicates whether the scheduled task is forcibly executed.	false
RatioThreshold	float	The threshold for the ratio of connected sessions, which triggers automatic scaling of cloud computers within the multi-session many-to-many share. To calculate the ratio of connected sessions, use the following formula: `Ratio of connected sessions = Number of connected sessions/(Total number of cloud computers × Maximum number of sessions allowed for each cloud computer) × 100%`. If the session ratio exceeds the threshold, new cloud computers are provisioned. If it falls below the threshold, additional cloud computers are removed.	0.6
ConnectDuration	long	The maximum period of time during which the session is connected. When the specified maximum period of time is reached, the session is automatically disconnected. Unit: milliseconds.	60000
IdleDisconnectDuration	long	After an end user connects to a cloud computer, the session is established. If the system does not detect any inputs from the keyboard or mouse within the specified period of time, the session is closed. Unit: milliseconds.	900000
Version	long	The version number of the cloud computer share.	1
StopDuration	long	The period of time before the idle cloud computer enters the Stopped state. If the specified value is reached, the cloud computer is automatically stopped. If an end user connects to the stopped cloud computer, the cloud computer automatically starts. Unit: milliseconds.	180000
ProfileFollowSwitch	boolean	Indicates whether user data roaming is enabled.	true
NasFileSystemID	string	The ID of the File Storage NAS (NAS) file system for the user data roaming feature.	0783b4****
NasFileSystemName	string	The name of the NAS file system for the user data roaming feature.	abcd
TimingStrategyInfo	string	The information about the scheduling policy.	abcd
ScaleTimerInfos	array<object>	The scheduled tasks.
ScaleTimerInfo	object	The scheduled task.
Type	string	The type of the scheduled task. Valid values: drop: decline policy normal: normal policy peak: peak hour policy rise: rise policy	rise
Cron	string	The cron expression for the scheduled task.	0 0 0 * * ?
LoadPolicy	integer	The load balancing policy for the multi-session many-to-many share. Valid values: 0: depth-first. 1: breadth-first.	1
BuyResAmount	integer	The number of cloud computers that you purchase in the cloud computer pool. This parameter is one of the auto scaling parameters. Valid values: 0 to 200.	5
MinResAmount	integer	The minimum number of cloud computers in the cloud computer pool. This parameter is one of the auto scaling parameters. Valid values: 0 to 200.	1
MaxResAmount	integer	The maximum number of cloud computers in the cloud computer pool. This parameter is one of the auto scaling parameters. Valid values: 0 to 200.	100
KeepDuration	long	The duration that is retained after the session is disconnected. Unit: milliseconds. Valid values: 180000 to 345600000. That is, the session can be retained for 3 to 5760 minutes (4 days). If you specify the value to 0, the session is permanently retained. When a session is disconnected, take note of the following situations: If an end user does not resume the session within the specified duration, the session is closed and all unsaved data is cleared. If the end user resumes the session within the specified duration, the end user can still access data of the session.	600000
RatioThreshold	float	The threshold for the ratio of connected sessions, which triggers automatic scaling of cloud computers within the multi-session many-to-many share. To calculate the ratio of connected sessions, use the following formula: `Ratio of connected sessions = Number of connected sessions/(Total number of cloud computers × Maximum number of sessions allowed for each cloud computer) × 100%`. If the session ratio exceeds the threshold, new cloud computers are provisioned. If it falls below the threshold, additional cloud computers are removed.	0.5
PolicyGroupIds	array	The IDs of the applied policies.
policyGroupId	string	The ID of the policy.	pd-abcd***
PolicyGroupNames	array	The names of the applied policies.
policyGroupName	string	The name of the applied policy.	abcd
BuyDesktopsCount	integer	The number of purchased cloud computers in the subscription share. Valid values: 0 to 200. The minimum initial number of cloud computers created in the pay-as-you-go share. Default value: 1. Valid values: 0 to `MaxDesktopsCount`.	5
ImageId	string	The ID of the image.	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 time	Summary of changes	Operation
2021-11-04	The response structure of the API has changed	View Change Details