Table of Contents

管理面总览

三入口同源

一切管理操作走同一份契约（management-api.json 契约源，206 路由×29 命令族）， 三个入口只是不同载体：

入口 载体 适合
CLI / TUI traffic-worker <命令族>…（经管理口 REST 翻译） 脚本/运维/单次操作
管理 REST /api/v1/…（OpenAPI 3.1 文档自描述） 程序集成/自动化
控制台 UI 内嵌 /ui/*（SPA 消费同一契约） 日常人工操作

不存在第二套管理定义——CLI 命令模型编译期生成 HttpApi 翻译，UI 消费同一契约源 派生的 routes.json。三层防漂移由构建期机器对账门保证（paths≡catalog≡样例解析）。

鉴权

管理口 Bearer 鉴权：

curl -H "Authorization: Bearer <key>" http://127.0.0.1:7901/api/v1/sys/cluster/status
  • 密钥在 worker.json admin.keys 配置（env:/file: 引用）；
  • 权限模型（scope × 租户绑定）见权限模型；
  • 403＝结构化信封（code 指明缺失的 scope/租户边界——不是裸文本）。

系统域与租户域

域 路径 例
租户域 /api/v1/{tenant}/… config/orch/publish/route/trace/alert/vars…
系统域 /api/v1/sys/… cluster/plugin/tenant/tenant-resolver/mock-options/geoip…
元端点 /api/v1/meta/…、meta/openapi.json openapi 文档/routes 投影/health

租户域的 {tenant} 段即操作目标租户；系统域操作平台全局（集群成员、平台插件、 租户目录），受 scope 控制更严。

实时面（SSE）

管理口还挂四条 SSE 流（Bearer 鉴权）：events（数据面事件）、audit stream、 publish progress、KV watch（外部只读订阅）——见可观测。

Edit this page