Skip to main content
Version: 5.1.0

get_incr_sync_status

所属分类:运维诊断 · Tool 名称get_incr_sync_status

功能说明

获取指定管道增量(实时)同步的详细运行状态。TIS 的增量同步基于 Flink 实时通道(部署在 K8s 上)运行,本 Tool 按「是否已配置 → 是否已部署 → 是否运行中」的层次逐级检查,返回明确的状态机值。适用于确认实时通道是否存活、以及 toggle_incr_sync 操作后的结果确认。

输入参数

参数类型必填说明
pipelinestring管道名称(可通过 list_pipeline 获取)

输出结果

业务 JSON 直返(非信封结构),字段说明如下:

字段类型说明
pipelinestring管道名称(回显入参)
configuredboolean是否已配置增量同步通道
runningboolean增量同步是否运行中
statestring状态机值,见下表
errorMsgstring状态检查过程中发生异常时的错误信息(仅 stateERROR 时可能出现)

state 取值:

含义
NOT_CONFIGURED该管道未配置增量同步通道
NOT_DEPLOYED已配置但尚未部署过增量实例(K8s 资源未创建)
RUNNING增量同步运行中
STOPPED增量实例已部署但当前处于停止状态
ERROR状态检查过程发生异常(详见 errorMsg

返回示例

运行中的增量通道:

{
"pipeline": "mysql2doris_orders",
"configured": true,
"running": true,
"state": "RUNNING"
}

未配置增量通道的管道:

{
"pipeline": "mysql2es_employee",
"configured": false,
"running": false,
"state": "NOT_CONFIGURED"
}

错误返回

情况表现
pipeline 为空MCP 层 isError: true,内容为参数错误描述文本
服务端内部异常MCP 层 isError: true,内容为通用错误提示文本

注意点

  1. ERROR 状态表示状态检查本身出错(如 K8s API 不可达),不代表同步一定异常,请结合 errorMsg 判断。
  2. get_pipeline_status 的区别:后者提供「批量 + 增量」的概要视图,本 Tool 专注于增量通道的细分状态机。
  3. 调用 toggle_incr_sync 启动 / 停止增量同步后,建议间隔数秒再调用本 Tool 确认操作结果——增量实例的启动与停止是异步过程。

典型用法

在 Hermes 中的提问示例:

mysql2doris_orders 的实时同步还在跑吗?
使用 get_incr_sync_status 工具:确认一下 mysql2doris_orders 增量通道现在的状态