DescribeGlobalTimerRecords - 查询全局定时任务执行记录

更新时间:
复制为 MD 格式

查询各地域云电脑的定时任务执行记录。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:DescribeGlobalTimerRecordslist
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-shanghai
TimerTypesarray

定时任务列表。

string

定时任务类型。

定时任务:

  • TimerBoot:定时开机
  • TimerShutdown:定时关机
  • TimerReboot:定时重启
  • TimerReset:定时重置
  • TimerMaintenance:定时进入维护模式
  • TimerHibernate:定时休眠

无操作任务:

  • NoOperationShutdown:无操作关机
  • NoOperationReboot:无操作重启
  • NoOperationDisconnect:无操作断连
  • NoOperationHibernate:无操作休眠

断连任务:

  • NoConnectShutdown:断连关机
  • NoConnectHibernate:断连休眠
TimerBoot
MaxResultsstring

分页查询时每页行数。

最大值:100。

默认值:10。

10
NextTokenstring

下一个查询开始的 Token。

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
SearchRegionIdstring

搜索地域 ID。用于过滤出指定地域的云电脑信息。

cn-shanghai
BatchIdstring

定时类任务执行的批次 ID。

ccg-****
TimerResultstring

定时任务的执行结果。

枚举值:
  • CONNECTED_NOT_RUN云电脑已被连接,定时任务未执行
  • PAUSED执行暂停
  • COMPLETED已完成
  • FAILED执行失败
  • RUNNING运行中
  • TERMINATED执行中止
RUNNING
GroupIdstring

定时任务组 ID。

ccg-0cvfvf6u1enx1****
ResultCategorystring

通过执行结果进行过滤。

枚举值:
  • SUCCEED执行成功
  • FAILED执行失败
  • RUNNING执行中
  • SKIPPED执行被跳过
SUCCEED
DesktopIdsarray

云电脑 ID 列表。

string

云电脑 ID。

ecd-84mztzatmipf2****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

下一个查询开始的 Token,NextToken 为空表示没有下一个。

AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****
Countinteger

总条目数。

2
Resultsarray<object>

返回结果信息。

Recordobject

结果列表。

BatchIdstring

定时类任务执行的批次 ID。

ccg-0cvfvf6u1enx1****
TimerTypestring

定时任务类型。

TimerBoot
TimerResultstring

定时任务的执行结果。

RUNNING
CreateTimestring

记录创建时间。

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

任务结束时间。

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

云电脑 ID。

ecd-0c951fy9arnk9****
RegionIdstring

地域 ID。

cn-hangzhou
DesktopNamestring

云电脑名称。

DesktopName
TimerGroupIdstring

定时任务组 ID。

ccg-xxxx
ActionTypestring

执行的动作类型。

REBOOT
Contextstring

定时任务执行过程中的记录信息。

{}

示例

正常返回示例

JSON格式

{
  "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": "",
      "Retryable": true,
      "TimerRecordId": ""
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2025-12-24OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2025-12-17新增 OpenAPI查看变更详情