All Products
Search

This Product

    Elastic Desktop Service:SetDesktopGroupTimer

    Document Center

    Elastic Desktop Service:SetDesktopGroupTimer

    Last Updated:Jun 11, 2026

    Configures a scheduled start, stop, restart, or reset task for a computer pool.

    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

    Yes

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    cn-hangzhou
    DesktopGroupId

    string

    Yes

    The ID of the computer pool.

    dg-dbdkfmh883****
    TimerType

    integer

    Yes

    The type of the scheduled task.

    Valid values:

    • 1: scheduled reset

    • 2: scheduled startup

    • 3: scheduled stop

    • 4: scheduled restart

    Valid values:

    • 1 :

      1

    • 2 :

      2

    • 3 :

      3

    • 4 :

      4

    1
    CronExpression

    string

    No

    The cron expression for the scheduled task. This parameter is required when TimerType is set to 2, 3, or 4.

    0 0 9 * * ?
    ResetType

    integer

    No

    The type of the disk that you want to reset.

    Valid values:

    • does not reset disks.

    • resets only the system disk.

    • resets only the user disk.

    • resets the system disk and the user disk.

    Valid values:

    • 0 :

      does not reset disks.

    • 1 :

      resets only the system disk.

    • 2 :

      resets only the user disk.

    • 3 :

      resets the system disk and the user disk.

    1
    Force

    boolean

    No

    Specifies whether to forcefully execute the scheduled task.

    true

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The ID of the request.

    388CF76E-FFB3-5174-9F91-CDD****

    Examples

    Success response

    JSON format

    {
  "RequestId": "388CF76E-FFB3-5174-9F91-CDD****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.