get_incr_sync_status
所属分类:运维诊断 · Tool 名称:
get_incr_sync_status
功能说明
获取指定管道增量(实时)同步的详细运行状态。TIS 的增量同步基于 Flink 实时通道(部署在 K8s 上)运行,本 Tool 按「是否已配置 → 是否已部署 → 是否运行中」的层次逐级检查,返回明确的状态机值。适用于确认实时通道是否存活、以及 toggle_incr_sync 操作后的结果确认。
输入参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
pipeline | string | 是 | 管道名称(可通过 list_pipeline 获取) |
输出结果
业务 JSON 直返(非信封结构),字段说明如下:
| 字段 | 类型 | 说明 |
|---|---|---|
pipeline | string | 管道名称(回显入参) |
configured | boolean | 是否已配置增量同步通道 |
running | boolean | 增量同步是否运行中 |
state | string | 状态机值,见下表 |
errorMsg | string | 状态检查过程中发生异常时的错误信息(仅 state 为 ERROR 时可能出现) |
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,内容为通用错误提示文本 |
注意点
ERROR状态表示状态检查本身出错(如 K8s API 不可达),不代表同步一定异常,请结合errorMsg判断。- 与
get_pipeline_status的区别:后者提供「批量 + 增量」的概要视图,本 Tool 专注于增量通道的细分状态机。 - 调用
toggle_incr_sync启动 / 停止增量同步后,建议间隔数秒再调用本 Tool 确认操作结果——增量实例的启动与停止是异步过程。
典型用法
在 Hermes 中的提问示例:
mysql2doris_orders 的实时同步还在跑吗?
使用 get_incr_sync_status 工具:确认一下 mysql2doris_orders 增量通道现在的状态