启动结构对比任务
启动指定的结构对比任务。一次性任务会立即执行;周期性任务可只启用调度,也可启用调度后立即执行一次。
请求地址:/openapi/v1/compareschema/execute
请求方法:POST
调用前准备
taskId 可通过 创建结构对比任务 的成功响应 data.taskId 获取。建议先调用 启动结构对比预检查 并确认预检查成功。
请求参数
| 参数 | 类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| taskId | String | 是 | 需要启动的结构对比任务 ID。 | cc-th6j3fs58y |
| runNow | Boolean | 否 | 是否在启用周期调度后立即执行一次,默认值为 false。仅周期性任务需要关注该参数;一次性任务会直接立即执行。 | true |
runNow 参数说明
| 任务类型 | runNow | 行为 | 返回值 |
|---|---|---|---|
| 一次性任务 | false 或 true | 立即执行结构对比。 | execId |
| 周期性任务 | false | 启用周期调度。 | 不返回 execId |
| 周期性任务 | true | 启用周期调度,并立即执行一次。 | execId |
请求示例
{
"taskId": "cc-th6j3fs58y",
"runNow": true
}
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Boolean | 请求是否成功。 | true |
| requestId | String | 请求 ID,可用于问题排查和链路追踪。 | Bi5j8CFB-jpqkjCHnlppg7MYdkot2FHM |
| data | Long | 当前结构对比任务最新启动的子任务 ID,即 execId。 | 46958 |
| message | String | 错误信息。请求失败时返回。 | task status invalid |
调用成功示例
{
"success": true,
"requestId": "Bi5j8CFB-jpqkjCHnlppg7MYdkot2FHM",
"data": 46958
}