跳转至

源表依赖触发

本文档用于说明 调度体系下,通过 OpenAPI 方式 触发源表依赖任务实例方式:

  • 按调度时间点触发

  • 按调度时间范围触发

一、接口能力概述

触发方式 接口名称 适用场景
按调度时间点 triggerTableTaskInstanceByScheduleTime 精确触发指定调度时间的实例(可多个时间点)
按调度时间范围 triggerTableTaskInstanceByScheduleTimeRange 批量触发某一时间区间内的实例

二、按调度时间点触发源表实例

1. 接口说明

新调度源表实例触发(按调度时间点)

用于触发 指定调度时间点 的源表依赖任务实例。

  • 支持一次传入 多个调度时间点

  • 若实例已存在,再次触发将 重跑当前实例及其下游

2. 接口URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/scheduler/task/triggerTableTaskInstanceByScheduleTime

anymetrics_host:anymetrics_port 获取方式请参考:调用方式

3. 请求参数

3.1 公共请求参数(HEADERS)

参数 类型 是否必选 最大长度 描述
tenant-id String 32 租户ID,用于指标查询内容所在的租户
auth-type String 32 认证方式,用于设置身份认证方式 UID:使用 UID 进行身份认证TOKEN:使用 TOKEN 进行身份认证ACCOUNT:使用ACCOUNT 进行身份认证
auth-value String 32 UID、TOKEN值、ACCOUNT,与auth-type 类型选择一致

3.2 公共参数获取方式

tenant-id 与 auth-value:在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成。在 API 集成界面获取取到tenant-id 与auth-value。

4. 请求体(Body)

参数名 类型 是否必填 说明
tableName String 源表名称(支持 catalog.db.table)
tenantId String 租户 ID
scheduleTimes Array 调度时间点列表(yyyy-MM-dd HH:mm:ss

5. 请求示例

curl --location --request POST 'http://anymetrics:8083/anymetrics/api/v1/scheduler/task/triggerTableTaskInstanceByScheduleTime' \
--header 'tenant-id: tn_19487697' \
--header 'auth-value: 463663891121963008' \
--header 'auth-type: UID' \
--data-raw '{
  "tableName":"kehuzhisheng.chaos_prod.chaos_onsite_bug",
  "tenantId":"tn_19487697",
  "scheduleTimes":[
    "2026-01-20 00:00:00",
    "2026-01-20 01:00:00"
  ]
}'

6. 响应示例

{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "fbb0da5c96fb481bbadc8b7722307480.188.17688821533020289"
}

三、按调度时间范围触发源表实例

1. 接口说明

新调度源表实例触发(按调度时间范围)

用于触发 指定时间范围内 的源表依赖任务实例。

  • 会扫描并触发该时间区间内的所有调度实例

  • 若实例已存在,再次触发将 重跑当前实例及其下游

2. 接口URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/scheduler/task/triggerTableTaskInstanceByScheduleTimeRange

anymetrics_host:anymetrics_port 获取方式请参考:调用方式

3. 请求参数

3.1 公共请求参数(HEADERS)

参数 类型 是否必选 最大长度 描述
tenant-id String 32 租户ID,用于指标查询内容所在的租户
auth-type String 32 认证方式,用于设置身份认证方式 UID:使用 UID 进行身份认证TOKEN:使用 TOKEN 进行身份认证ACCOUNT:使用ACCOUNT 进行身份认证
auth-value String 32 UID、TOKEN值、ACCOUNT,与auth-type 类型选择一致

3.2 公共参数获取方式

tenant-id 与 auth-value:在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成。在 API 集成界面获取取到tenant-id 与auth-value。

4. 请求体(Body)

参数名 类型 是否必填 说明
tableName String 源表名称
tenantId String 租户 ID
startTime String 开始调度时间(yyyy-MM-dd HH:mm:ss
endTime String 结束调度时间(yyyy-MM-dd HH:mm:ss

5. 请求示例

curl --location --request POST 'http://anymetrics:8083/anymetrics/api/v1/scheduler/task/triggerTableTaskInstanceByScheduleTimeRange' \
--header 'tenant-id: tn_19487697' \
--header 'auth-value: 463663891121963008' \
--header 'auth-type: UID' \
--data-raw '{
  "tableName":"default_catalog.sales.FACT_SALES",
  "tenantId":"tn_19487697",
  "startTime":"2026-01-20 01:00:00",
  "endTime":"2026-01-20 05:00:00"
}'

6. 响应示例

{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "eaec2f7d9b33452493481dc960658b42.193.17688826774900347"
}