All Products
Search

This Product

    Elastic Desktop Service:ModifyTimerGroup

    Document Center

    Elastic Desktop Service:ModifyTimerGroup

    Last Updated:Jun 10, 2026

    Modify settings in a configuration group, such as for scheduled tasks.

    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 region ID. Set this parameter to cn-shanghai.

    cn-shanghai
    GroupId

    string

    Yes

    The ID of the configuration group.

    cg-i1ruuudp92qpj****
    ConfigTimers

    array<object>

    No

    The scheduled task configurations.

    array<object>

    No

    A single scheduled task configuration.

    TimerType

    string

    No

    The type of the scheduled task.

    Valid values:

    • NoOperationDisconnect :

      Disconnects the session when idle.

    • NoConnect :

      Performs an action when no session is connected. You must specify the OperationType parameter.

    • TimerBoot :

      Boots the cloud desktop at the scheduled time.

    • TimerReset :

      Resets the cloud desktop at the scheduled time.

    • NoOperationShutdown :

      Shuts down the cloud desktop when idle.

    • NoOperationHibernate :

      Hibernates the cloud desktop when idle.

    • TimerShutdown :

      Shuts down the cloud desktop at the scheduled time.

    • NoOperationReboot :

      Reboots the cloud desktop when idle.

    • TimerReboot :

      Reboots the cloud desktop at the scheduled time.

    TimerBoot
    CronExpression

    string

    No

    The cron expression for the scheduled task.

    Note

    The cron expression is based on UTC. For example, to run a task daily at 00:00 China Standard Time (UTC+8), set the expression to 0 0 16 ? * 1,2,3,4,5,6,7.

    0 0 16 ? * 1,2,3,4,5,6,7

    Interval

    integer

    No

    The interval in minutes.

    10
    Enforce

    boolean

    No

    If true, the task runs regardless of the desktop and connection status.

    false
    ResetType

    string

    No

    Specifies which disks to reset.

    Valid values:

    • RESET_TYPE_SYSTEM :

      Resets the system disk.

    • RESET_TYPE_USER_DISK :

      Resets the data disk.

    • RESET_TYPE_BOTH :

      Resets both the system disk and the data disk.

    RESET_TYPE_SYSTEM
    AllowClientSetting

    boolean

    No

    If true, end users can configure scheduled tasks.

    true
    OperationType

    string

    No

    The action to perform. This parameter is valid only when TimerType is set to NoConnect.

    Valid values:

    • Hibernate :

      Hibernates the cloud desktop.

    • Shutdown :

      Shuts down the cloud desktop.

    Shutdown
    TriggerType

    string

    No

    The trigger type for scheduled tasks that are based on user inactivity.

    Valid values:

    • Advanced :

      Smart detection

    • Standard :

      Standard detection

    Standard
    ProcessWhitelist

    array

    No

    A list of processes that, if running, prevent an idle task from being triggered. This only applies when TriggerType is Advanced.

    string

    No

    The process name.

    chrome
    NotificationTime

    integer

    No

    SegmentTimers

    array<object>

    No

    object

    No

    OperationType

    string

    No

    StartCronExpression

    string

    No

    EndCronExpression

    string

    No

    Interval

    integer

    No

    TriggerType

    string

    No

    ProcessWhitelist

    array

    No

    string

    No

    NotificationTime

    integer

    No

    TimerOrder

    integer

    No

    Timezone

    string

    No

    Enforce

    boolean

    No

    ResetType

    string

    No

    ImageId

    string

    No

    The ID of the image for a scheduled image update task.

    m-5b0vjqbiqu010XXXXXX
    LockScreenTime

    integer

    No

    The number of seconds of inactivity before the screen is locked. This setting only applies to AD desktops.

    1800
    AppointmentTimer

    integer

    No

    The execution time for a one-time task, specified as a Unix timestamp in milliseconds.

    1764660600967
    VerificationTime

    integer

    No

    VerificationNotificationTime

    integer

    No

    IpSegments

    array

    No

    string

    No

    Name

    string

    No

    The name of the configuration group.

    Scheduled task
    Description

    string

    No

    The description of the configuration group.

    Scheduled task

    Response elements

    Element

    Type

    Description

    Example

    object

    The response data.

    RequestId

    string

    The request ID.

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

    string

    The group ID.

    cg-i1ruuudp92qpj****

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 OperationTooFrequent The operation is too frequent, please try again later. Operation is too frequent, please try again later

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.