All Products
Search

This Product

    Elastic Desktop Service:DescribeGlobalTimerRecords

    Document Center

    Elastic Desktop Service:DescribeGlobalTimerRecords

    Last Updated:Jun 10, 2026

    Queries the execution records for scheduled tasks on cloud computers in a region.

    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. Call DescribeRegions to obtain a list of regions that support WUYING Workspace.

    cn-shanghai
    TimerTypes

    array

    No

    A list of scheduled task types.

    string

    No

    The type of the scheduled task.

    Scheduled tasks:

    • TimerBoot: Scheduled startup

    • TimerShutdown: Scheduled shutdown

    • TimerReboot: Scheduled restart

    • TimerReset: Scheduled reset

    • TimerMaintenance: Scheduled maintenance

    • TimerHibernate: Scheduled hibernation

    No-operation tasks:

    • NoOperationShutdown: Shutdown after no operations

    • NoOperationReboot: Restart after no operations

    • NoOperationDisconnect: Disconnect after no operations

    • NoOperationHibernate: Hibernate after no operations

    Disconnection tasks:

    • NoConnectShutdown: Shutdown after disconnection

    • NoConnectHibernate: Hibernate after disconnection

    Valid values:

    • NoOperationDisconnect :

      Disconnect after no operations

    • NoConnectShutdown :

      Shutdown after disconnection

    • TimerBoot :

      Scheduled startup

    • NoOperationShutdown :

      Shutdown after no operations

    • NoOperationHibernate :

      Hibernate after no operations

    • NoConnectHibernate :

      Hibernate after disconnection

    • TimerShutdown :

      Scheduled shutdown

    • NoOperationReboot :

      Restart after no operations

    • TimerReboot :

      Scheduled restart

    TimerBoot
    MaxResults

    string

    No

    The number of entries to return on each page.

    Maximum value: 100.

    Default value: 10.

    10
    NextToken

    string

    No

    The token that starts the next page of results.

    AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
    SearchRegionId

    string

    No

    The ID of the region to search. Use this parameter to filter information about cloud computers in a specific region.

    cn-shanghai
    BatchId

    string

    No

    The batch ID for the execution of the scheduled task.

    ccg-****
    TimerResult

    string

    No

    The execution result of the scheduled task.

    Valid values:

    • CONNECTED_NOT_RUN :

      The cloud computer is connected, and the scheduled task was not executed.

    • PAUSED :

      The execution is paused.

    • COMPLETED :

      The task is complete.

    • FAILED :

      The execution failed.

    • RUNNING :

      The task is running.

    • TERMINATED :

      The execution is aborted.

    RUNNING
    GroupId

    string

    No

    The ID of the scheduled task group.

    ccg-0cvfvf6u1enx1****
    ResultCategory

    string

    No

    Filters the results by execution status.

    Valid values:

    • SUCCEED :

      The task was executed successfully.

    • FAILED :

      The task failed to execute.

    • RUNNING :

      The task is being executed.

    • SKIPPED :

      The task execution was skipped.

    SUCCEED
    DesktopIds

    array

    No

    A list of cloud computer IDs.

    string

    No

    The ID of the cloud computer.

    ecd-84mztzatmipf2****
    Retryable

    boolean

    No

    true
    DisplayResultName

    string

    No

    FAILED

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    63740E03-1B4B-5A18-AC27-2745A4F2****
    NextToken

    string

    The token used to start the next page of results. If this parameter is empty, all results have been returned.

    AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****
    Count

    integer

    The total number of entries.

    2
    Results

    array<object>

    The details of the results.

    object

    A list of results.

    BatchId

    string

    The batch ID for the execution of the scheduled task.

    ccg-0cvfvf6u1enx1****
    TimerType

    string

    The type of the scheduled task.

    TimerBoot
    TimerResult

    string

    The execution result of the scheduled task.

    RUNNING
    CreateTime

    string

    The time when the record was created.

    2023-08-03T08:27:29Z
    FinishTime

    string

    The time when the task was finished.

    2025-01-21T02:00:45Z
    DesktopId

    string

    The ID of the cloud computer.

    ecd-0c951fy9arnk9****
    RegionId

    string

    The region ID.

    cn-hangzhou
    DesktopName

    string

    The name of the cloud computer.

    DesktopName
    TimerGroupId

    string

    The ID of the scheduled task group.

    ccg-xxxx
    ActionType

    string

    The type of action that was performed.

    REBOOT
    Context

    string

    The information recorded during the execution of the scheduled task.

    {}
    DisplayResultName

    string

    SKIPPED
    Retryable

    boolean

    true
    TimerRecordId

    string

    t-xxx
    ResourceParentId

    string

    p-xxx

    Examples

    Success response

    JSON format

    {
  "RequestId": "63740E03-1B4B-5A18-AC27-2745A4F2****",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****",
  "Count": 2,
  "Results": [
    {
      "BatchId": "ccg-0cvfvf6u1enx1****",
      "TimerType": "TimerBoot",
      "TimerResult": "RUNNING",
      "CreateTime": "2023-08-03T08:27:29Z",
      "FinishTime": "2025-01-21T02:00:45Z",
      "DesktopId": "ecd-0c951fy9arnk9****",
      "RegionId": "cn-hangzhou",
      "DesktopName": "DesktopName",
      "TimerGroupId": "ccg-xxxx",
      "ActionType": "REBOOT",
      "Context": "{}",
      "DisplayResultName": "SKIPPED",
      "Retryable": true,
      "TimerRecordId": "t-xxx",
      "ResourceParentId": "p-xxx"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.