Skip to main content
Version: 5.1.0

trigger_pipeline_batch_synchronize

所属分类：轻量操作 · Tool 名称：trigger_pipeline_batch_synchronize

功能说明​

触发指定管道执行一次批量全量数据同步，返回 taskId 用于后续状态查询与日志查看。等效于在 TIS 控制台手动点击「触发构建」。

操作类 Tool

本 Tool 会真实触发一次数据同步任务，可能对源端和目标端产生实际读写压力。建议在 Agent 客户端开启 Tool 调用确认机制，由用户二次确认后执行。

输入参数​

参数类型必填说明
pipelinestring是管道唯一性名称（可通过 list_pipeline 获取）

输出结果​

业务 JSON 直返（非信封结构），字段说明如下：

字段类型说明
successboolean是否触发成功（注意：仅表示「触发」动作受理成功，不代表同步任务本身执行成功）
taskIdinteger触发产生的任务 ID，仅 success 为 true 时出现；可用于 get_task_log 查询日志
msgstring结果描述文本

返回示例​

触发成功：

{
  "success": true,
  "taskId": 1025,
  "msg": "已成功触发管道 mysql2doris_orders 的批量全量同步"
}

触发失败：

{
  "success": false,
  "msg": "触发失败 "
}

错误返回​

情况表现
pipeline 为空MCP 层 isError: true，内容为参数错误描述文本
触发未被受理（管道不支持批量同步、任务冲突等）返回 success: false，详见 msg
服务端内部异常MCP 层 isError: true，内容为通用错误提示文本

注意点​

  1. 前置确认：执行前请确保目标管道支持批量同步——可先调用 list_pipeline 检查 supportBatchSynchronize 是否为 true。
  2. 触发 ≠ 完成：success: true 仅表示任务已进入执行队列。同步是否成功需通过 get_pipeline_status（关注 lastBatchStatus）或 get_pipeline_exec_history 持续跟踪。
  3. 任务跟踪链路：触发成功 → 记录 taskId → 用 get_pipeline_status 轮询状态 → 失败时用 get_task_log 拉取日志。
  4. 重复触发同一管道前，建议先确认上一次触发的任务已结束，避免任务排队或资源争抢。

典型用法​

在 Hermes 中的提问示例：

帮我跑一下 mysql2doris_orders 的全量同步
使用 trigger_pipeline_batch_synchronize 工具：触发 mysql2doris_orders 的批量同步，触发后告诉我 taskId