Skip to main content
Version: 5.1.0

list_pipeline

所属分类：数据资产感知 · Tool 名称：list_pipeline

功能说明​

列出 TIS 中所有的端到端数据同步管道，返回每个管道的名称、Reader（源端）/ Writer（目标端）插件类型，以及是否支持批量 / 增量同步。是后续调用其他管道类 Tool（如 get_pipeline_status、trigger_pipeline_batch_synchronize）前确认管道名称与能力的首选入口。

输入参数​

无参数。

输出结果​

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

字段类型说明
pipelinearray端到端数据同步管道列表，按最近处理时间倒序排列
pipeline[].namestring管道唯一性名称（其他管道类 Tool 的 pipeline 入参即使用该值）
pipeline[].readerTypestringReader（源端）插件类型，如 MySQL、Oracle 等
pipeline[].writerTypestringWriter（目标端）插件类型，如 Doris、Elasticsearch 等
pipeline[].supportBatchSynchronizeboolean是否支持批量端到端数据同步（Reader 与 Writer 均支持时为 true）
pipeline[].supportIncrSynchronizeboolean是否支持增量端到端数据同步（Reader 与 Writer 均支持时为 true）

返回示例​

{
  "pipeline": [
    {
      "name": "mysql2doris_orders",
      "readerType": "MySQL",
      "writerType": "Doris",
      "supportBatchSynchronize": true,
      "supportIncrSynchronize": true
    },
    {
      "name": "mysql2es_employee",
      "readerType": "MySQL",
      "writerType": "Elasticsearch",
      "supportBatchSynchronize": true,
      "supportIncrSynchronize": false
    }
  ]
}

错误返回​

情况表现
服务端内部异常MCP 层 isError: true，内容为通用错误提示文本

注意点​

  1. 数量上限：最多返回 1000 条管道记录，超大型部署下请注意该上限。
  2. 加载失败的管道会被跳过：个别管道的 Reader / Writer 插件缺失或配置损坏时，该管道不会出现在列表中。
  3. supportBatchSynchronize / supportIncrSynchronize 表示管道的配置能力，不代表当前正在运行。要确认增量同步是否在运行，请使用 get_pipeline_status 或 get_incr_sync_status。
  4. 在调用 trigger_pipeline_batch_synchronize 前，建议先通过本 Tool 确认目标管道的 supportBatchSynchronize 为 true。

典型用法​

在 Hermes 中的提问示例：

TIS 里有哪些数据管道？
使用 list_pipeline 工具：找出所有目标端是 Doris 的管道