DescribeDesktopGroups-阿里云帮助中心

View shared cloud desktops and their details.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the regions that support Elastic Desktop Service.	cn-hangzhou
OfficeSiteId	string	No	The ID of the office network to which the desktop group belongs.	cn-hangzhou+dir-467671****
DesktopGroupName	string	No	The name of the desktop group. Fuzzy search is supported.	CloudComputerPool01
DesktopGroupId	string	No	The ID of the desktop group.	dg-2i8qxpv6t1a03****
Period	integer	No	The subscription duration of the desktop group. The unit of the duration is specified by the `PeriodUnit` parameter. Valid values when `PeriodUnit` is set to `Month`: 1 2 3 6 Valid values when `PeriodUnit` is set to `Year`: 1 2 3 4 5	1
PeriodUnit	string	No	The unit of the subscription duration. Valid values: Month : Month Year : Year	Month
MaxResults	integer	No	The number of entries to return on each 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
PolicyGroupId	string	No	The ID of the policy that is associated with the desktop group.	pg-53iyi2aar0nd6****
Status	integer	No	The status of the desktop group. Valid values: 0 : Unpaid 1 : Normal 2 : Overdue or expired	1
OwnType	integer	No	The type of the desktop group. Note This parameter is not publicly available. Valid values: 0 : Single-session multiple shared cloud desktops 1 : Multiple multi-session shared cloud computers	0
EndUserIds	array	No	The IDs of the authorized users of the desktop group.
	string	No	The ID of the authorized user.	alice
ExcludedEndUserIds	array	No	The IDs of the users that you want to exclude.
	string	No	The ID of the user that you want to exclude.	Tony
ProtocolType	string	No	The protocol type. Valid values: HDX : HDX protocol ASP : Alibaba Cloud proprietary ASP protocol	ASP
ImageId	array	No	The image IDs.
	string	No	The image ID.	m-eeuo9qab4b0****
BundleId	array	No	The desktop template IDs.
	string	No	The desktop template ID.	b-4w5nk44znm6****
Tag	array<object>	No	The tags. A maximum of 20 tags can be specified.
	object	No	The tag.
Key	string	No	The key of the tag. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.	TestKey
Value	string	No	The value of the tag. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.	TestValue
MultiResource	boolean	No	Specifies whether the desktop group consists of multiple desktops. Valid values: true : Multiple shared cloud desktops false : Single shared cloud computer	true
DesktopGroupIds	array	No	The desktop group IDs.
	string	No	A desktop group ID.	dg-2i8qxpv6t1a03****
DesktopType	string	No
QosRuleId	string	No

Response elements

Element	Type	Description	Example
	object	The data returned.
NextToken	string	The token used to start the next query.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopGroups	array<object>	An array of shared cloud desktop groups.
	array<object>	The details of a shared cloud desktop group.
CreateTime	string	The creation time of the shared cloud desktop group.	2022-02-17T14:51:07Z
PayType	string	The billing method. Valid values: PostPaid : pay-as-you-go PrePaid : subscription	PrePaid
PolicyGroupName	string	The name of the policy associated with the shared cloud desktop group.	All enabled policy
Creator	string	The ID of the Alibaba Cloud account that created the shared cloud desktop group.	1007214305******
MaxDesktopsCount	integer	For pay-as-you-go shared cloud desktops, this is the maximum number of cloud desktops that can be created in the group. For subscription shared cloud desktops, this is the sum of initially purchased cloud desktops (`BuyDesktopsCount`) and the cloud desktops that can be automatically created.	3
SystemDiskSize	integer	The size of the system disk. Unit: GiB.	80
PolicyGroupId	string	The ID of the policy associated with the shared cloud desktop group.	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 memory size.	16 GiB
OwnBundleName	string	The name of the desktop template.	test
DataDiskCategory	string	The type of the data disk. Valid values: cloud_efficiency : ultra disk cloud_ssd : standard SSD cloud_essd : ESSD cloud disk	cloud_ssd
DesktopGroupName	string	The name of the shared cloud desktop group.	CloudComputerPool01
SystemDiskCategory	string	The type of the system disk. Valid values: cloud_efficiency : ultra disk cloud_ssd : standard SSD cloud_essd : ESSD cloud disk	cloud_ssd
OfficeSiteId	string	The ID of the shared cloud desktop group's office network.	cn-hangzhou+dir-467671****
KeepDuration	integer	The retention period for a disconnected session. Unit: milliseconds. Valid values: 180000 (3 minutes) to 345600000 (4 days). If you set this parameter to 0, the session is retained indefinitely. When a session disconnects, it is retained for this period. If a user fails to reconnect within this period, the session is terminated and unsaved data is deleted. If the user reconnects within this period, they can resume their original session.	180000
MinDesktopsCount	integer	For pay-as-you-go shared cloud desktops, this is the minimum number of cloud desktops maintained in the group. For subscription shared cloud desktops, this is the number of initially purchased cloud desktops, which is specified by `BuyDesktopsCount`.	1
EndUserCount	integer	The number of users authorized to use the shared cloud desktop group.	1
DataDiskSize	string	The size of the data disk. Unit: GiB.	50
DesktopGroupId	string	The ID of the shared cloud desktop group.	dg-2i8qxpv6t1a03****
OfficeSiteName	string	The name of the shared cloud desktop group's office network.	cn-hangzhou+os-c5cy7q578s8jc****
Cpu	integer	The number of vCPUs.	4
ExpiredTime	string	The expiration time of the group's subscription.	2022-03-17T16:00:00Z
Comments	string	The comments for the shared cloud desktop group.	comment
OfficeSiteType	string	The account 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 cloud desktop group. Valid values: 0 : Unpaid 1 : Normal 2 : Overdue or Expired	1
ResetType	integer	The reset type for the shared cloud desktops in the group. Valid values: 0 : Does not reset desktops. 1 : Resets only the system disks. 2 : Resets only the data disks. 3 : Resets the system disks and data disks.	0
LoadPolicy	integer	The load balancing policy for multi-session shared cloud desktop groups. Valid values: 0 : depth-first 1 : breadth-first	1
BindAmount	integer	The maximum number of concurrent sessions per cloud desktop in a multi-session shared cloud desktop group.	2
OwnType	integer	The type of the shared cloud desktop group. Valid values: 0 : Single-session 1 : Multi-session	0
ImageId	string	The image ID.	m-gq15cq5ydlvwn****
VolumeEncryptionEnabled	boolean	Indicates whether disk encryption is enabled.	false
VolumeEncryptionKey	string	The ID of the Key Management Service (KMS) key used for disk encryption.	e5409ada-xxxx-xxxx-xxxx-89e31e23e993
RatioThreshold	number	The session utilization threshold that triggers auto scaling. This parameter is valid only for multi-session shared cloud desktop groups. Session utilization is calculated as follows: `Session utilization = Number of connected sessions / (Total number of cloud desktops × Maximum sessions per cloud desktop) × 100%`	0.85
ConnectDuration	integer	The maximum duration of a session. When a session reaches this duration, it is automatically disconnected. Unit: milliseconds.	3600000
IdleDisconnectDuration	integer	The idle timeout for a session. A session is automatically disconnected if no keyboard or mouse activity occurs for this duration. Unit: milliseconds.	90000
Version	integer	The version of the shared cloud desktop group.	2
StopDuration	integer	The duration that a cloud desktop can be idle before it is automatically stopped. When a user attempts to connect to a stopped desktop, it automatically starts. Unit: milliseconds.	900000
ProtocolType	string	The protocol used to connect to the cloud desktops. Valid values: HDX : HDX protocol ASP : Alibaba Cloud-proprietary ASP protocol	ASP
OsType	string	The operating system. Valid values: Linux : Linux Windows : Windows	Windows
BuyDesktopsCount	integer	The number of purchased cloud desktops. This parameter is valid only for subscription shared cloud desktop groups. Valid values: 0 to 200.	5
DesktopCount	integer	The number of cloud desktops created in the group.	2
DesktopType	string	The desktop type of the cloud desktops in the group. You can call the DescribeDesktopTypes operation to query the desktop types supported by WUYING Workspace.	eds.enterprise_office.4c4g
CountPerStatus	array<object>	An array of cloud desktop counts, categorized by status.
	object	The details of the cloud desktop count for a specific status.
Status	string	The status of the cloud desktops. Valid values: Stopped : The cloud desktops are stopped. Starting : The cloud desktops are being started. Rebuilding : The cloud desktops are being rebuilt. Running : The cloud desktops are running. Stopping : The cloud desktops are being stopped. Expired : The cloud desktops are expired. Deleted : The cloud desktops are deleted. Pending : The cloud desktops are pending creation.	Running
Count	integer	The number of cloud desktops in the specified status.	10
GpuDriverVersion	string	The GPU driver version.	12
SubnetId	string	The subnet ID.	vsw-uf63bb6*****8gfytm
Tags	array<object>	The tags attached to the shared cloud desktop group.
	object	The details of a tag.
Key	string	The tag key.	desktop_group_name
Value	string	The tag value.	ds-dq2mybjr23yw*****
UserOuPath	string	The path to the user account's organizational unit (OU).	example.com
IsLdap	boolean
UserGroupName	string
PolicyGroupIdList	array
	string
PolicyGroupNameList	array
	string
SimpleUserGroupId	string
OrgId	string
AccountType	string
EntraDomainName	string
ExpiredTimes	array
	string
EnvType	string
EnvId	string
QosRuleId	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": "",
      "OrgId": "",
      "AccountType": "",
      "EntraDomainName": "",
      "ExpiredTimes": [
        ""
      ],
      "EnvType": "",
      "EnvId": "",
      "QosRuleId": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.