Admin API
本页所有 Admin API 都监听 Metasrv 的 HTTP_PORT，默认值为 4000。
Admin API 通过 HTTP 提供 Metasrv 状态、集群控制和元数据恢复操作。该 API 不提供认证，且部分端点会改变集群行为或元数据分配，部署时必须通过网络策略保护 HTTP 端口。 本页介绍以下 API：
- /health
- /leader
- /heartbeat
- /node-lease
- /maintenance
- /procedure-manager
- /recovery
- /sequence/table
所有这些 API 都在父资源 /admin 下。
在以下部分中，我们假设你的 metasrv 实例运行在本地主机的 4000 端口。
/health HTTP 端点
/health 端点接受 GET 请求。HTTP 服务运行时返回 OK，但不会检查当前 Metasrv 是否为 leader，也不会检查外部依赖是否可用。
定义
curl -X GET http://localhost:4000/admin/health
示例
请求
curl -X GET http://localhost:4000/admin/health
响应
OK
/leader HTTP 端点
/leader 端点接受 GET HTTP 请求，你可以使用此端点查询你的 metasrv 实例的 leader 地址。
定义
curl -X GET http://localhost:4000/admin/leader
示例
请求
curl -X GET http://localhost:4000/admin/leader
响应
127.0.0.1:4000
/heartbeat HTTP 端点
/heartbeat 端点接受 GET HTTP 请求，你可以使用此端点查询所有数据节点的心跳。
你还可以查询指定 addr 的数据节点的心跳数据，但在路径中指定 addr 是可选的。
定义
curl -X GET http://localhost:4000/admin/heartbeat
| 查询字符串参数 | 类型 | 可选/必选 | 定义 |
|---|---|---|---|
| addr | String | 可选 | 数据节点的地址。 |
示例
请求
curl -X GET 'http://localhost:4000/admin/heartbeat?addr=127.0.0.1:4100'
响应
[
[
{
"timestamp_millis": 1677049348651,
"id": 1,
"addr": "127.0.0.1:4100",
"rcus": 0,
"wcus": 0,
"region_num": 2,
"region_stats": [],
"topic_stats": [],
"node_epoch": 0,
"datanode_workloads": {
"types": []
},
"gc_stat": null
}
]
]
/node-lease HTTP 端点
/node-lease 返回 Metasrv 当前记录的 Datanode lease，可用于判断 Metasrv 是否仍将某个 Datanode 视为存活。
curl -X GET http://localhost:4000/admin/node-lease
/maintenance HTTP 端点
维护模式在升级、计划停机等操作期间临时禁用自动集群管理。它对集群的具体影响参见集群维护模式。
/maintenance 端点支持以下 HTTP 请求：
GET /admin/maintenance或GET /admin/maintenance/status：查询维护模式状态。POST /admin/maintenance/enable：启用维护模式。POST /admin/maintenance/disable：禁用维护模式。
响应体使用以下格式：
{
"enabled": true
}
/procedure-manager HTTP 端点
该端点用于管理 Procedure Manager 状态。有关更多详细信息，请参阅防止元数据变更。
/procedure-manager 端点支持以下 HTTP 请求：
GET /admin/procedure-manager/status：查询 Procedure Manager 状态。POST /admin/procedure-manager/pause：暂停 Procedure Manager。POST /admin/procedure-manager/resume：恢复 Procedure Manager。
响应体使用以下格式：
{
"status": "running"
}
/recovery HTTP 端点
Recovery mode 控制手动修改 table ID sequence 等元数据修复端点。它只用于恢复工作，不用于常规维护。
GET /admin/recovery/status：查询 recovery mode 是否开启。POST /admin/recovery/enable：开启 recovery mode。POST /admin/recovery/disable：关闭 recovery mode。
响应体格式如下：
{
"enabled": true
}
修复完成后应关闭 recovery mode。如果只是计划暂停自动集群操作，应使用维护模式。
/sequence/table HTTP 端点
这些端点用于检查或修复 table ID sequence：
GET /admin/sequence/table/next-id：返回下一个 table ID，但不执行分配。POST /admin/sequence/table/set-next-id：推进下一个 table ID。
设置 sequence 前必须开启 recovery mode。新值必须大于当前值，不能通过该 API 回退 sequence。Recovery mode 只是该 API 的前置条件，不能阻止 DDL。执行该操作时，必须遵循管理 Table ID Sequence中的完整集群操作流程。
curl -X POST \
-H 'Content-Type: application/json' \
-d '{"next_table_id": 2048}' \
http://localhost:4000/admin/sequence/table/set-next-id
该操作会影响 后续新表分配到的 ID。