跳到主要内容

启动结构对比任务

启动指定的结构对比任务。一次性任务会立即执行;周期性任务可只启用调度,也可启用调度后立即执行一次。

请求地址:/openapi/v1/compareschema/execute

请求方法:POST

调用前准备

taskId 可通过 创建结构对比任务 的成功响应 data.taskId 获取。建议先调用 启动结构对比预检查 并确认预检查成功。

请求参数

参数类型是否必填说明示例
taskIdString需要启动的结构对比任务 ID。cc-th6j3fs58y
runNowBoolean是否在启用周期调度后立即执行一次,默认值为 false。仅周期性任务需要关注该参数;一次性任务会直接立即执行。true

runNow 参数说明

任务类型runNow行为返回值
一次性任务falsetrue立即执行结构对比。execId
周期性任务false启用周期调度。不返回 execId
周期性任务true启用周期调度,并立即执行一次。execId

请求示例

{
"taskId": "cc-th6j3fs58y",
"runNow": true
}

返回参数

参数类型说明示例
successBoolean请求是否成功。true
requestIdString请求 ID,可用于问题排查和链路追踪。Bi5j8CFB-jpqkjCHnlppg7MYdkot2FHM
dataLong当前结构对比任务最新启动的子任务 ID,即 execId46958
messageString错误信息。请求失败时返回。task status invalid

调用成功示例

{
"success": true,
"requestId": "Bi5j8CFB-jpqkjCHnlppg7MYdkot2FHM",
"data": 46958
}