DescribeTimerGroup - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries a scheduled task configuration group.

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region. Set the value to `cn-shanghai`.	cn-hangzhou
GroupId	string	Yes	The ID of the configuration group.	cg-hs3i1w39o68ma****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Data	object	The information about the scheduled task group.
GroupId	string	The ID of the configuration group.	cg-75aazkg2tnqb2*****
Name	string	The name of the configuration group.
Description	string	The description of the configuration group.
Type	string	The type of the configuration group. Valid value: Timer: the scheduled task type.	Timer
ProductType	string	The service type of the configuration group. Valid value: CLOUD_DESKTOP: the cloud computer service.	CLOUD_DESKTOP
ConfigTimers	array<object>	The scheduled task configurations.
ConfigTimer	object	The scheduled task configuration.
TimerType	string	The type of the scheduled task. Valid values: NoOperationDisconnect: scheduled disconnection upon inactivity. NoConnect: scheduled disconnection upon specified operation (OperationType). TimerBoot: scheduled start. TimerReset: scheduled reset. NoOperationShutdown: scheduled shutdown upon inactivity. NoOperationHibernate: scheduled hibernation upon inactivity. TimerShutdown: scheduled shutdown. NoOperationReboot: scheduled restart upon inactivity. TimerReboot: scheduled restart.	TimerBoot
CronExpression	string	The CRON expression for the scheduled task.	0 0 16 ? * 1,2,3,4,5,6,7
Interval	integer	The interval at which the scheduled task is executed. Unit: minutes.	10
Enforce	boolean	Specifies whether to forcibly execute the scheduled task. A value of true specifies the scheduled task will run forcefully, ignoring the cloud computer and connection status.	false
ResetType	string	The reset operation of the scheduled task. Valid values: RESET_TYPE_SYSTEM: resets the system disk. RESET_TYPE_USER_DISK: resets the data disk. RESET_TYPE_BOTH: resets the system disk and data disk.	RESET_TYPE_SYSTEM
AllowClientSetting	boolean	Indicates whether end users can configure scheduled tasks.	true
OperationType	string	The type of the scheduled disconnection task. Valid values: Hibernate: scheduled hibernation. Shutdown: scheduled shutdown.	Shutdown
TriggerType	string	The method to trigger the scheduled task upon inactivity. Valid values: Advanced: intelligent detection. Standard: standard detection.	Standard
ProcessWhitelist	array	The process whitelist. If whitelisted processes are running, the scheduled task upon inactivity does not take effect.
Process	string	The name of the process.	chrome
BindCount	integer	The number of resources that are bound to the configuration group.	50
Status	string	The state of the configuration group. Valid values: AVAILABLE: The configuration group is available. UNAVAILABLE: The configuration group is deleted. DELETING: The configuration group is being deleted. UPDATING: The configuration group is being modified.	AVAILABLE
BindCountMap	object	The number of bound resources.
	integer	The number of bound resource.	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Data": {
    "GroupId": "cg-75aazkg2tnqb2*****",
    "Name": "",
    "Description": "",
    "Type": "Timer",
    "ProductType": "CLOUD_DESKTOP",
    "ConfigTimers": [
      {
        "TimerType": "TimerBoot",
        "CronExpression": "0 0 16 ? * 1,2,3,4,5,6,7\n",
        "Interval": 10,
        "Enforce": false,
        "ResetType": "RESET_TYPE_SYSTEM",
        "AllowClientSetting": true,
        "OperationType": "Shutdown",
        "TriggerType": "Standard",
        "ProcessWhitelist": [
          "chrome"
        ],
        "NotificationTime": 0
      }
    ],
    "BindCount": 50,
    "Status": "AVAILABLE",
    "BindCountMap": {
      "key": 10
    }
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-03-27	The response structure of the API has changed	View Change Details