DescribeGlobalTimerRecords - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the execution records of scheduled tasks on cloud computers.

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:DescribeGlobalTimerRecords	list	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 list of regions where Elastic Desktop Service (EDS) Enterprise is available.	cn-shanghai
TimerTypes	array	No	The scheduled tasks.
	string	No	The type of the scheduled task. Valid values: NoOperationDisconnect: scheduled disconnection upon inactivity. NoOperationDisconnect: scheduled disconnection upon inactivity. TimerBoot: scheduled start. NoOperationShutdown: scheduled shutdown upon inactivity. NoOperationHibernate: scheduled hibernation upon inactivity. NoConnectHibernate: scheduled hibernation upon disconnection. TimerShutdown: scheduled shutdown. NoOperationReboot: scheduled restart upon inactivity. TimerReboot: scheduled restart.	TimerBoot
MaxResults	string	No	The number of entries per page. Maximum value: 100. Default value: 10.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
SearchRegionId	string	No	The ID of the searched region. You can specify this parameter to filter cloud computers in specific regions.	cn-shanghai
BatchId	string	No	The ID of the batch in which the scheduled task is executed.	ccg-****
TimerResult	string	No	The execution result of the scheduled task. Valid values: CONNECTED_NOT_RUN: The cloud computer is connected, but the scheduled task is not executed. PAUSED: The scheduled task is suspended. COMPLETED: The scheduled task is executed. FAILED: The scheduled task failed to be executed. RUNNING: The scheduled task is being executed. TERMINATED: The scheduled task is stopped.	RUNNING
GroupId	string	No	The ID of the scheduled task group.	ccg-0cvfvf6u1enx1****
ResultCategory	string	No	The type of the execution result. You can specify this parameter to filter the execution results. Valid values: FAILED: The execution is successful. FAILED: The execution failed. RUNNING: The execution is in progress. SKIPPED: The execution is skipped.	SUCCEED
DesktopIds	array	No	The cloud computer IDs.
	string	No	The cloud computer ID.	ecd-84mztzatmipf2****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	63740E03-1B4B-5A18-AC27-2745A4F2****
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.	AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****
Count	integer	The total number of entries returned.	2
Results	array<object>	The response parameters.
Record	object	The execution results.
BatchId	string	The ID of the batch in which the scheduled task is executed.	ccg-0cvfvf6u1enx1****
TimerType	string	The type of the scheduled task.	TimerBoot
TimerResult	string	The execution result of the scheduled task.	RUNNING
CreateTime	string	The time when the execution record was created.	2023-08-03T08:27:29Z
FinishTime	string	The time when the scheduled task ended.	2025-01-21T02:00:45Z
DesktopId	string	The cloud computer ID.	ecd-0c951fy9arnk9****
RegionId	string	The region ID.	cn-hangzhou
DesktopName	string	The cloud computer name.	DesktopName
TimerGroupId	string	The ID of the scheduled task group.	ccg-xxxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "63740E03-1B4B-5A18-AC27-2745A4F2****",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****",
  "Count": 2,
  "Results": [
    {
      "BatchId": "ccg-0cvfvf6u1enx1****",
      "TimerType": "TimerBoot",
      "TimerResult": "RUNNING",
      "CreateTime": "2023-08-03T08:27:29Z",
      "FinishTime": "2025-01-21T02:00:45Z",
      "DesktopId": "ecd-0c951fy9arnk9****",
      "RegionId": "cn-hangzhou",
      "DesktopName": "DesktopName",
      "TimerGroupId": "ccg-xxxx"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-12-17	Add Operation	View Change Details