查询定时任务执行历史记录的批次信息，并且返回汇总的执行结果。
接口说明
- 此接口为中心化域名，接入点为上海或新加坡，不支持其他地域调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecd:DescribeGlobalTimerBatches | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。
| cn-shanghai |
| TimerType | string | 否 | 需要查询的任务类型。仅有定时类任务可以查询到批次信息。
| 1 |
| MaxResults | string | 否 | 返回最大数量。 | 20 |
| NextToken | string | 否 | 下一个查询开始的 Token，NextToken 为空表示没有下一个。 | caeba0bbb2be03f84eb48b699f0a4883 |
| SearchRegionId | string | 否 | 搜索地域 ID。用于过滤出指定地域的云电脑信息。 | cn-hangzhou |
| GroupId | string | 否 | 定时任务组 ID。 | ccg-i1ruuudp92qpj**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "E54EB497-D7B7-5F04-B744-D8DFA7B******",
"Count": 1,
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"Results": [
{
"BatchId": "ccg-0cvfvf6u1enx1****",
"TimerType": "TimerBoot",
"CreateTime": "2023-08-03T08:27:29Z",
"SucceedCount": 0,
"FailedCount": 0,
"SkippedCount": 0,
"RunningCount": 0
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-12-17 | 新增 OpenAPI | 查看变更详情 |