跳到主要内容

管理 API

本页用于给出 YedMQ 管理接口的高层索引。具体请求体、响应体和字段定义请以生成的管理 API 参考为准。

系统与插件接口

GET /api/v1/system_info
GET /api/v1/plugins

租户范围接口

GET /api/v1/{tenant_id}/clients
POST /api/v1/{tenant_id}/clients/{client_id}/kickoff
GET /api/v1/{tenant_id}/topics
GET /api/v1/{tenant_id}/messages/retained
DELETE /api/v1/{tenant_id}/messages/retained/{topic}
POST /api/v1/{tenant_id}/messages

集群接口

GET /api/v1/cluster/metrics
GET /api/v1/cluster/ready
POST /api/v1/cluster/init
POST /api/v1/cluster/learners
POST /api/v1/cluster/nodes
POST /api/v1/cluster/topic/learners
POST /api/v1/cluster/session_actor_map/learners
POST /api/v1/cluster/session_state/learners
POST /api/v1/cluster/membership
POST /api/v1/cluster/topic/membership
POST /api/v1/cluster/session_actor_map/membership
POST /api/v1/cluster/session_state/membership
POST /api/v1/cluster/raft/topic/init
POST /api/v1/cluster/raft/session_actor_map/init
POST /api/v1/cluster/raft/session_state/init

集群操作说明

GET /api/v1/cluster/ready 会返回结构化的就绪状态，适合用于健康检查和编排系统的准入判断。
POST /api/v1/cluster/nodes 是新增节点的高层流程，会协调三个 raft 组的 learner 添加和 membership 变更。
按 raft 维度暴露的 .../learners 接口更适合做分阶段发布、故障恢复或手工修复。

推荐阅读顺序

先阅读概览页，理解认证方式与接口分组。
再查看生成的 OpenAPI 参考，获取精确 payload。
自动化脚本里显式传递 tenant ID，避免跨租户误操作。

系统与插件接口
租户范围接口
集群接口
集群操作说明
推荐阅读顺序