All Products
Search

This Product

    Elastic Desktop Service:ModifyTimerGroup

    Document Center

    Elastic Desktop Service:ModifyTimerGroup

    Last Updated:Oct 31, 2025

    Modifies 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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    ecd:ModifyTimerGrouplist
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The ID of the region. Set the value to cn-shanghai.

    		cn-hangzhou
    GroupIdstringYes

    The ID of the configuration group.

    		cg-i1ruuudp92qpj****
    ConfigTimersarray<object>No

    The scheduled task groups.

    objectNo

    The scheduled task group.

    TimerTypestringNo

    The scheduled task type.

    Valid value:

    • 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.
    		TIMER_BOOT
    CronExpressionstringNo

    The cron expression specified in the scheduled task.

    Note The time must be in UTC. For example, if your local time is 24:00 (UTC+8), you must set the value to 0 0 16 ? * 1,2,3,4,5,6,7.
    		0 0 16 ? * 1,2,3,4,5,6,7
    IntervalintegerNo

    The interval at which the scheduled task is executed. Unit: minutes.

    		10
    EnforcebooleanNo

    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
    ResetTypestringNo

    The reset option.

    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
    AllowClientSettingbooleanNo

    Specifies whether to allow end users to configure scheduled tasks.

    		true
    OperationTypestringNo

    The type of the scheduled operation. If you set TimerType to NoConnect, you can specify this parameter.

    Valid values:

    • Hibernate: scheduled hibernation.
    • Shutdown: scheduled shutdown.
    		Shutdown
    TriggerTypestringNo

    The method to trigger the scheduled task upon inactivity.

    Valid values:

    • Advanced: intelligent detection.
    • Standard: standard detection.
    		Standard
    ProcessWhitelistarrayNo

    The process whitelist. If whitelisted processes are running, the scheduled task does not take effect upon inactivity.

    stringNo

    The process name.

    		chrome
    NamestringNo

    The name of the configuration group.

    DescriptionstringNo

    The description of the configuration group.

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    GroupIdstring

    The ID of the configuration group.

    		cg-i1ruuudp92qpj****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "GroupId": "cg-i1ruuudp92qpj****"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2025-03-27The internal configuration of the API is changed, but the call is not affectedView Change Details