DescribeGlobalDesktopRecords API Reference - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Queries basic information and usage duration for all recent Cloud Desktops.

Operation description

Select China (Shanghai) for the Alibaba Cloud China site and Singapore for the Alibaba Cloud International site.
By default, this operation returns both active and deleted Cloud Desktops.
You can query only Cloud Desktops deleted within the last three months.
You cannot use the sort condition with other query conditions.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeGlobalDesktopRecords

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. Shanghai Singapore	cn-shanghai
OfficeSiteId	string	No	The ID of the office site. China (Shanghai) Singapore	cn-hangzhou+dir-363353****
StartTime	string	No	The start time of the query. The time must be in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format.	2022-03-23T04:10:21Z
EndTime	string	No	The end time of the query. The time must be in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format. The interval between the start and end times cannot exceed 30 days. Format: YYYY-MM-DDThh:mm:ssZ.	2022-08-31T06:56:45Z
PageNumber	integer	No	The page number to return. Default value: 1. Format: YYYY-MM-DDThh:mm:ssZ.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100.	20
DesktopId	array	No	The IDs of the cloud desktops. You can specify up to 100 IDs.
	string	No	The ID of the cloud desktop.	ecd-gx2x1dhsmucyy****
DesktopName	string	No	The name of the cloud desktop.	DemoComputer
SubPayType	string	No	The billing method of the cloud desktop. Valid values:	monthPackage
Scope	string	No	The query scope. This parameter is empty by default. Valid value: `ADVANCED`: Queries statistical records, such as connection duration. postPaid: Pay-as-you-go. monthPackage: monthly time-based package.	ADVANCED
OrderBy	string	No	The field by which to sort the results. If you do not specify this parameter, the results are sorted by creation time in descending order. Valid value: `uptime`: Sorts the results by cloud desktop uptime.	uptime
SortType	string	No	The sort order. The default is `Asc`. Valid values: `Asc`: ascending order	Asc
EndUserId	string	No	The ID of the end user. Asc: ascending order Desc: descending order	TestUser
DesktopType	string	No	The desktop type. You can call the DescribeDesktopTypes operation to query the IDs of the supported desktop types.	eds.enterprise_office.2c4g
ResourceGroupId	string	No	The ID of the resource group.	rg-3mtuc28rx95lx****
DesktopStatusList	array	No	The ID of the resource group.
	string	No
ExcludeDesktopStatusList	array	No
	string	No

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	1
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Sessions	array<object>	A list of sessions.
	array<object>	The session details.
Platform	string	The operating system version.	Windows 10
StatusChangeTime	integer	The time when the cloud desktop status changed.	1760583xxxx
Memory	integer	The memory size of the cloud desktop, in MiB.	4096
DesktopName	string	The name of the cloud desktop.	DemoComputer
Cpu	integer	The number of vCPUs.	2
SubPayType	string	The billing method for the cloud desktop. Valid values: `prePaid`: Subscription. `postPaid`: Pay-as-you-go. `monthPackage`: Monthly usage package.	monthPackage
EndUserId	string	The ID of the end user.	TestUser
OsType	string	The operating system type. Valid values: `Windows` `Linux`	Linux
SessionIdleTime	integer	The idle duration of the session, in minutes.	120
OfficeSiteName	string	The name of the office site.	TestOfficeSite
ConnectionStatus	string	The connection status.	Connected
Sessions	array<object>	A list of sessions.
	object	The session details for the end user.
EndUserId	string	The ID of the end user.	TestUser
EstablishmentTime	string	The time the session was created.	2022-08-31T06:56:45Z
DesktopId	string	The ID of the cloud desktop.	ecd-g6t1ukbaea****
EndUserIds	array	A list of assigned end user IDs.
	string	The ID of the end user.	TestUser
ResourceGroups	array<object>	A list of resource groups.
	object	The resource group details.
ResourceGroupId	string	The ID of the resource group.	rg-f3s3dgt8dtb0vlqc8
ResourceGroupName	string	The name of the resource group.	dms_test
OfficeSiteId	string	The ID of the office site.	cn-hangzhou+dir-8904****
UpTime	integer	The cloud desktop uptime, in seconds.	86400
ProtocolType	string	The protocol type. Valid values: `HDX` `ASP`	ASP
GpuSpec	string	The GPU memory size.	8GiB
LatestConnectionTime	integer	The duration of the last connection, in seconds.	120
TotalConnectionTime	integer	The total connection duration, in seconds.	240
RegionId	string	The ID of the region.	cn-beijing
DesktopGroupId	string	The ID of the computer pool.	dg-iaqu3bi2xtie****
DesktopGroupName	string	The name of the computer pool.	DemoCCGroup
DesktopStatus	string	The desktop status.	Running
OfficeSiteType	string	The office site type.	Simple

Examples

Success response

JSON format

{
  "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",
      "OfficeSiteType": "Simple"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.