DescribeGlobalDesktopRecords - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the basic information of all cloud computers and the corresponding usage duration records.

Operation description

Domestic site users query site selection Shanghai, international site users choose Singapore.
By default, you can query all cloud computers that are deleted or not deleted.
Deleted cloud computers can be queried only if the deletion time is less than three months.
Sort criteria cannot be shared with other criteria.

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:DescribeGlobalDesktopRecords	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. China (Shanghai) Singapore	cn-shanghai
OfficeSiteId	string	No	The office network IDs.	cn-hangzhou+dir-363353****
StartTime	string	No	The start time. Supported formats: Format: YYYY-MM-DDThh:mm:ssZ.	2022-03-23T04:10:21Z
EndTime	string	No	The end time. The interval between the start time and end time can be up to 30 days. Supported formats: Format: YYYY-MM-DDThh:mm:ssZ.	2022-08-31T06:56:45Z
PageNumber	integer	No	The page number of the current page. Default value: 1	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100.	20
DesktopId	array	No	The cloud computer IDs. You can specify 1 to 100 office network IDs.
	string	No	The ID of the cloud desktop.	ecd-gx2x1dhsmucyy****
DesktopName	string	No	The name of the cloud computer.	DemoComputer
SubPayType	string	No	The way to purchase cloud computers. Valid values: prePaid: The monthly purchase is unlimited. postPaid: pay-as-you-go monthPackage: monthly duration.	monthPackage
Scope	string	No	The query range. This parameter is empty by default. Optional values are: ADVANCED: indicates that statistics such as the connection duration are queried.	ADVANCED
OrderBy	string	No	The sorting field. If this parameter is not provided, results are sorted by creation time in descending order. Valid values: uptime: indicates that the cloud computers are sorted by startup duration.	uptime
SortType	string	No	The sorting method. Default value: ascending. Valid value: Asc: ascending order Desc: descending.	Asc
EndUserId	string	No	The end user ID.	TestUser
DesktopType	string	No	The cloud computer type. You can call the DescribeDesktopTypes operation to query the IDs of the specifications supported by the cloud computer.	eds.enterprise_office.2c4g
ResourceGroupId	string	No	The ID of the resource group.	rg-3mtuc28rx95lx****

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	1
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Sessions	array<object>	The session details.
Session	object	The details of the session.
Platform	string	The specific model of the operating system.	Windows 10
StatusChangeTime	long	The time when the status of the cloud computer was changed.	1760583xxxx
Memory	long	The memory of the cloud computer. Unit: MiB.	4096
DesktopName	string	The cloud computer name.	DemoComputer
Cpu	integer	The number of vCPUs.	2
SubPayType	string	The billing method of the cloud computer. Valid values: prePaid: The monthly purchase is unlimited. postPaid: pay-as-you-go monthPackage: monthly duration.	monthPackage
EndUserId	string	The end user ID.	TestUser
OsType	string	The OS type. Valid values: Windows Linux	Linux
SessionIdleTime	long	The idle duration of the session. Unit: minutes.	120
OfficeSiteName	string	The office network name.	TestOfficeSite
ConnectionStatus	string	The connection status of the cloud desktop.	Connected
Sessions	array<object>	The session details.
Session	object	End user information.
EndUserId	string	The end user ID.	TestUser
EstablishmentTime	string	The time when the session was created.	2022-08-31T06:56:45Z
DesktopId	string	The cloud computer IDs.	ecd-g6t1ukbaea****
EndUserIds	array	The list of assigned terminal user IDs.
EndUserId	string	The end user ID.	TestUser
ResourceGroups	array<object>	The name of the enterprise resource group.
ResourceGroup	object	The name of the enterprise resource group.
ResourceGroupId	string	The ID of the enterprise resource group.	rg-f3s3dgt8dtb0vlqc8
ResourceGroupName	string	The queried resource group name.	dms_test
OfficeSiteId	string	The office network ID.	cn-hangzhou+dir-8904****
UpTime	long	The startup duration of the cloud computer. Unit: seconds	86400
ProtocolType	string	Protocol type. HDX ASP	ASP
GpuSpec	string	The size of the GPU memory.	8GiB
LatestConnectionTime	long	The duration of the last connection to the cloud computer. Unit: seconds	120
TotalConnectionTime	long	The total connection duration. Unit: seconds	240
RegionId	string	The ID of the region where the instance resides.	cn-beijing
DesktopGroupId	string	The ID of the cloud computer share.	dg-iaqu3bi2xtie****
DesktopGroupName	string	The name of the cloud computer share.	DemoCCGroup
DesktopStatus	string	桌面状态	Running

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Sessions": [
    {
      "Platform": "Windows 10",
      "StatusChangeTime": 0,
      "Memory": 4096,
      "DesktopName": "DemoComputer",
      "Cpu": 2,
      "SubPayType": "monthPackage",
      "EndUserId": "TestUser",
      "OsType": "Linux",
      "SessionIdleTime": 120,
      "OfficeSiteName": "TestOfficeSite",
      "ConnectionStatus": "Connected",
      "Sessions": [
        {
          "EndUserId": "TestUser",
          "EstablishmentTime": "2022-08-31T06:56:45Z"
        }
      ],
      "DesktopId": "ecd-g6t1ukbaea****",
      "EndUserIds": [
        "TestUser"
      ],
      "ResourceGroups": [
        {
          "ResourceGroupId": "rg-f3s3dgt8dtb0vlqc8",
          "ResourceGroupName": "dms_test"
        }
      ],
      "OfficeSiteId": "cn-hangzhou+dir-8904****",
      "UpTime": 86400,
      "ProtocolType": "ASP",
      "GpuSpec": "8GiB",
      "LatestConnectionTime": 120,
      "TotalConnectionTime": 240,
      "RegionId": "cn-beijing",
      "DesktopGroupId": "dg-iaqu3bi2xtie****",
      "DesktopGroupName": "DemoCCGroup",
      "DesktopStatus": "Running"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-10-21	Add Operation	View Change Details