DescribeDesktopsInGroup - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the cloud computers in a share by billing method.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:DescribeDesktopsInGroup	get	All Resources ``	none	none

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****
PayType	string	No	The billing method of the cloud computer share.	PrePaid
MaxResults	integer	No	The maximum number of entries per page. Default value: 10. Maximum value: 100.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	caeba0bbb2be03f84eb48b699f0a4883
IgnoreDeleted	boolean	No	Specifies whether to ignore deletion flags. Default value: true. Valid values: true: ignores deletion flags. The cloud computers that were deleted are returned. false: does not ignore deletion flags. The cloud computers that were deleted are not returned.	true

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
PostPaidDesktopsCount	integer	The total number of pay-as-you-go cloud computers.	10
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	caeba0bbb2be03f84eb48b699f0a4883
PaidDesktopsCount	integer	The total number of subscription cloud computers.	10
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
PostPaidDesktopsTotalAmount	integer	The total amount of bills for pay-as-you-go cloud computers.	10000
PaidDesktops	array<object>	The subscription cloud computers.
PaidDesktop	object	The subscription cloud desktop.
EndUserId	string	The ID of the authorized user.	alice
DesktopStatus	string	The status of the cloud computer. Valid values: Stopped Starting Rebuilding Running Stopping Expired Deleted Pending	Running
DesktopName	string	The name of the cloud computer.	testName
ConnectionStatus	string	The connection status of the cloud computer. Valid values: Unknown Connected Disconnected	Connected
DesktopId	string	The ID of the cloud computer.	ud-7ftf5b6yu77b0****
EndUserName	string	The username of the authorized user.	alice
ManagementFlag	string	The flag that is used to manage the cloud computer. Valid values: Updating: The configurations of the cloud computer are being updated. NoFlag: No flags are attached to the cloud computer.	NoFlag
EndUserIds	array	The IDs of the end users who are connected to the cloud computers in the cloud computer share. If no end users are connected, no values are returned for this parameter.
endUserIds	string	The ID of the end user.	alice
EndUserNames	array	The usernames of the end users who are connected to the cloud computers in the cloud computer share. If no end users are connected, no values are returned for this parameter.
endUserNames	string	The username of the user.	alice
ResetTime	string	The time when the cloud computer was reset.	2021-03-03 08:48:08
ImageId	string	The image ID.	m-hn5v2mmk0****
ImageName	string	The image name.	Win10_ZC
SystemDiskSize	integer	The system disk size. Unit: GiB.	80
OsType	string	The OS. Valid values: Linux Windows	Windows
GpuDriverVersion	string	The version of the GPU driver.	1.0
DiskType	string	The type of the disk. Valid values: SYSTEM: system disk DATA: data disk	SYSTEM
ManagementFlags	array	The flags that are used to manage the cloud computers.
managementFlags	string	The flag that is used to manage the cloud computer. Valid values: Updating: The configurations of the cloud computer are being updated. NoFlag: No flags are attached to the cloud computer.	NoFlag
MemberEniIp	string	The IP address of the member network interface controller (NIC) of the instance.	192.168.XX.XX
PrimaryEniIp	string	The IP address of the primary NIC of the instance.	192.168.XX.XX
ProtocolType	string	The protocol. Valid values: HDX: High-definition Experience (HDX) protocol ASP: Adaptive Streaming Protocol (ASP) protocol provided by Alibaba Cloud	ASP
FotaVersion	string	The image version.	0.1.0-R-20220914.17****
PostPaidDesktops	array<object>	The pay-as-you-go cloud computers.
PostPaidDesktop	object	The pay-as-you-go cloud computer.
CreateDuration	string	The retention period. Unit: milliseconds.	4153958447
EndUserId	string	The ID of the authorized user.	alice
DesktopStatus	string	The status of the cloud computer. Valid values: Stopped Starting Rebuilding Running Stopping Expired Deleted Pending	Stopped
CreateTime	string	The time when the cloud computer was created.	2022-01-21T06:34:57Z
ReleaseTime	string	The time when the cloud computer was released.	2022-01-21T16:34:57Z
DesktopName	string	The name of the cloud computer.	testName
ConnectionStatus	string	The connection status of the cloud computer. Valid values: Unknown Connected Disconnected	Connected
DesktopId	string	The ID of the cloud computer.	ud-2i8qxpv6t1a07****
EndUserName	string	The username of the authorized user.	alice
ManagementFlag	string	The flag that is used to manage the cloud computer. Valid values: Updating: The configurations of the cloud computer are being updated. NoFlag: No flags are attached to the cloud computer.	NoFlag
EndUserIds	array	The IDs of the end users who are connected to the cloud computers in the cloud computer pool. If no end users are connected, no values are returned for this parameter.
endUserIds	string	The ID of the end user.	alice
EndUserNames	array	The usernames of the end users who are connected to the cloud computers in the cloud computer pool. If no end users are connected, no values are returned for this parameter.
endUserNames	string	The username of the user.	alice
ResetTime	string	The time when the cloud computer was reset.	2021-03-03 08:48:08
ImageId	string	The image ID.	m-hn5v2mmk0****
ImageName	string	The image name.	Win10_ZC
SystemDiskSize	integer	The system disk size. Unit: GiB.	80
OsType	string	The OS. Valid values: Linux Windows	Windows
GpuDriverVersion	string	The version of the GPU driver.	1.0
DiskType	string	The type of the disk. Valid values: SYSTEM: system disk DATA: data disk	SYSTEM
ManagementFlags	array	The flags that are used to manage the cloud computers.
managementFlags	string	The flag that is used to manage the cloud computer. Valid values: Updating: The configurations of the cloud computer are being updated. NoFlag: No flags are attached to the cloud computer.	NoFlag
MemberEniIp	string	The IP address of the member NIC of the instance.	192.168.XX.XX
PrimaryEniIp	string	The IP address of the primary NIC of the instance.	192.168.XX.XX
ProtocolType	string	The protocol. Valid values: HDX: HDX protocol ASP: ASP protocol provided by Alibaba Cloud	HDX
FotaVersion	string	The image version.	0.1.0-R-20220914.17****
OnlinePrePaidDesktopsCount	integer	The number of subscription cloud computers that are in the Connected state.	100
RunningPrePaidDesktopsCount	integer	The number of subscription cloud computers that are in the Running state.	100
StopedPrePaidDesktopsCount	integer	The number of subscription cloud computers that are in the Stopped state.	100
StoppedPrePaidDesktopsCount	integer	The number of subscription cloud computers that are in the Stopped state.	100

Examples

Sample success responses

JSONformat

{
  "PostPaidDesktopsCount": 10,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PaidDesktopsCount": 10,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "PostPaidDesktopsTotalAmount": 10000,
  "PaidDesktops": [
    {
      "EndUserId": "alice",
      "DesktopStatus": "Running",
      "DesktopName": "testName",
      "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,
      "DiskType": "SYSTEM",
      "ManagementFlags": [
        "NoFlag"
      ],
      "MemberEniIp": "192.168.XX.XX",
      "PrimaryEniIp": "192.168.XX.XX",
      "ProtocolType": "ASP",
      "FotaVersion": "0.1.0-R-20220914.17****"
    }
  ],
  "PostPaidDesktops": [
    {
      "CreateDuration": 4153958447,
      "EndUserId": "alice",
      "DesktopStatus": "Stopped",
      "CreateTime": "2022-01-21T06:34:57Z",
      "ReleaseTime": "2022-01-21T16:34:57Z",
      "DesktopName": "testName",
      "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,
      "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

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

Change history

Change time	Summary of changes	Operation
2025-02-27	The request parameters of the API has changed	View Change Details
2023-06-19	The response structure of the API has changed	View Change Details
2022-10-14	The internal configuration of the API is changed, but the call is not affected	View Change Details