DescribeTimerGroup API Reference for Scheduled Task Groups - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Get the details of a specified configuration group.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region. This parameter must be set to `cn-shanghai`. Valid values: cn-shanghai : cn-shanghai	cn-shanghai
GroupId	string	Yes	The ID of the timer group.	cg-hs3i1w39o68ma****

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Data	object	The details of the timer group.
GroupId	string	The ID of the timer group.	cg-75aazkg2tnqb2*****
Name	string	The name of the timer group.	Scheduled task
Description	string	The description of the timer group.	Scheduled task
Type	string	The type of the timer group. Valid values: Timer : A scheduled task.	Timer
ProductType	string	The product type for the timer group. Valid values: CLOUD_DESKTOP : A cloud desktop.	CLOUD_DESKTOP
ConfigTimers	array<object>	The configurations of the scheduled tasks.
	array<object>	The configuration of a scheduled task.
TimerType	string	The type of the scheduled task. Valid values: NoOperationDisconnect : Disconnects the cloud desktop after a period of inactivity. NoConnect : Disconnects the cloud desktop based on the specified `OperationType`. TimerBoot : Starts the cloud desktop on a schedule. TimerReset : Resets the cloud desktop on a schedule. NoOperationShutdown : Shuts down the cloud desktop after a period of inactivity. NoOperationHibernate : Hibernates the cloud desktop after a period of inactivity. TimerShutdown : Shuts down the cloud desktop on a schedule. NoOperationReboot : Restarts the cloud desktop after a period of inactivity. TimerReboot : Restarts the cloud desktop on a schedule.	TimerBoot
CronExpression	string	The cron expression for the scheduled task.	0 0 16 ? * 1,2,3,4,5,6,7
Interval	integer	The duration of inactivity, in minutes, before the task is triggered.	10
Enforce	boolean	If set to `true`, the system forcibly runs the task, ignoring the desktop and connection status.	false
ResetType	string	The type of reset to perform. Valid values: RESET_TYPE_SYSTEM : Resets the system disk. RESET_TYPE_USER_DISK : Resets the data disk. RESET_TYPE_BOTH : Resets the system and data disks.	RESET_TYPE_SYSTEM
AllowClientSetting	boolean	Indicates whether end users can configure the scheduled task.	true
OperationType	string	The operation to perform for a `NoConnect` task. Valid values: Hibernate : Hibernates the cloud desktop. Shutdown : Shuts down the cloud desktop.	Shutdown
TriggerType	string	The trigger type for inactivity-based scheduled tasks. Valid values: Advanced : Smart detection. The task is not triggered if a process in the whitelist is running. Standard : Standard detection. The task is triggered based on user input inactivity.	Standard
ProcessWhitelist	array	A list of processes that prevent an inactivity-based task from triggering. This whitelist is effective only when `TriggerType` is set to `Advanced`.
	string	The name of the process.	chrome
NotificationTime	integer
SegmentTimers	array<object>
	object
StartCronExpression	string
EndCronExpression	string
OperationType	string
Interval	integer
TriggerType	string
ProcessWhitelist	array
	string
NotificationTime	integer
TimerOrder	integer
Timezone	string
Enforce	boolean
ResetType	string
ImageId	string	The ID of the image to use for tasks that change the desktop image.	m-5b0vjqbiqu010XXXXXX
LockScreenTime	integer	The duration of inactivity, in seconds, before the screen is locked. This feature applies only to Active Directory desktops.	1800
AppointmentTimer	integer	The specific time to run the scheduled task, specified as a UNIX timestamp in milliseconds.	1764660600967
PatchId	string		KB5082063
CreateSnapshot	boolean
VerificationTime	integer
VerificationNotificationTime	integer
IpSegments	array
	string
BindCount	integer	The number of resources that are bound to the timer group.	50
Status	string	The status of the timer group. Valid values: AVAILABLE : Available UNAVAILABLE : Deleted DELETING : Deleting UPDATING : Updating	AVAILABLE
BindCountMap	object	A map that provides a detailed breakdown of the number of bound resources.
	integer	The number of bound resources for a specific type or category.	10
IsBind	boolean	For internal use. This scheduled task cannot be bound or unbound.
IsUpdate	boolean	For internal use. This scheduled task cannot be modified.
InnerTimerName	string	An internal code representing the name of a system-defined scheduled task, used for display.	INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE
InnerTimerDesc	string	An internal code representing the description of a system-defined scheduled task, used for display.	INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Data": {
    "GroupId": "cg-75aazkg2tnqb2*****",
    "Name": "Scheduled task",
    "Description": "Scheduled task",
    "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,
        "SegmentTimers": [
          {
            "StartCronExpression": "",
            "EndCronExpression": "",
            "OperationType": "",
            "Interval": 0,
            "TriggerType": "",
            "ProcessWhitelist": [
              ""
            ],
            "NotificationTime": 0,
            "TimerOrder": 0,
            "Timezone": "",
            "Enforce": false,
            "ResetType": "",
            "ImageId": "m-5b0vjqbiqu010XXXXXX",
            "LockScreenTime": 1800,
            "AppointmentTimer": 1764660600967,
            "PatchId": "KB5082063",
            "CreateSnapshot": false,
            "VerificationTime": 0,
            "VerificationNotificationTime": 0,
            "IpSegments": [
              ""
            ]
          }
        ]
      }
    ],
    "BindCount": 50,
    "Status": "AVAILABLE",
    "BindCountMap": {
      "key": 10
    },
    "IsBind": false,
    "IsUpdate": false,
    "InnerTimerName": "INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE",
    "InnerTimerDesc": "INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.