CLI 命令族
CLI=traffic-worker <命令族> <动词> [参数] [选项](TUI——经管理口 REST 翻译层,
与 REST 同一契约)。动词语义全局一致:get/list/show=读,set/delete=写,
install/enable/disable/uninstall=生命周期,export/import=批量。
全局选项
| 选项 | 缺省 | 语义 |
|---|---|---|
--admin <url> |
http://127.0.0.1:7901 |
目标节点管理口 |
--tenant <id> |
default |
租户段 |
TRAFFIC_ADMIN_KEY 环境变量 |
— | Bearer 密钥自动附带 |
命令族地图(29 族×206 动词)
| 族 | 覆盖 |
|---|---|
config |
实体 CRUD(route/cluster/scope/listener/plugin/preroute/mockrule/orch/tenant/ai-*)——set 只写 draft |
orch |
编排图文档(save/get/list/delete+模板) |
publish |
dry-run / go / rollback / status / history / cancel / group advance·rollback |
route |
simulate(匹配仿真)/ conflicts(冲突遮蔽检索) |
cluster |
status(角色/Leader/水位/心跳)/ member add·remove(voter/learner/witness) |
target |
运行态清单 / drain(手动摘除)/ restore(手动恢复) |
metrics |
query / circuit(熔断态)/ steps(step 聚合)/ errors |
trace |
链路查询族(traceId 反查/span 瀑布) |
alert |
告警规则/通道/静音/激活清单(22 动词) |
deny |
TTL 黑名单运行态(即时生效) |
plugin |
install/list/enable/disable/uninstall/catalog/search/pull/trust/package/repo/quota(22 动词) |
key |
租户登录密钥(issue/list/revoke/delete) |
tenant / tenant-resolver |
租户目录与启停/租户解析策略表 |
discovery-source |
发现源注册/test/清单 |
resource |
外部资源密文($ref:resource 引用的目标) |
vars / policy / env |
租户变量/AccessPolicy/多环境 |
mock |
Mock 运行态(activate/dry-run) |
ai / consumer |
AI 目录(provider/prompt-rule)/ 消费者中心 |
gatewayapi / portal / sys |
Gateway API 面源/门户注册订阅/平台配置与元端点(29 动词) |
audit / diag / yaml / meta |
审计尾随 / 诊断 / 全集导出导入 / 元端点 |
带请求体的动词走 -f <file> 或 stdin 管道:
traffic-worker config set route k1 -f route.json、
echo '{...}' | traffic-worker config set route k1。
回执形态
- 写命令回执=
{ logicalAddress: hex32, generation }(版本戳); - 表格投影:数组回执按列渲染、对象纵排(
--json原样透传); - 错误统一信封:
{code, message, traceId, issues[]}——issues 精确到实体/字段, HTTP 语义错误映射 422/409/403。
脚本化纪律
export TRAFFIC_ADMIN_KEY=… # 密钥从环境进,不落命令行历史
traffic-worker publish dry-run && traffic-worker publish go # 先干跑后发布
写后读回(config get)确认版本戳;批量变更用 yaml export/import 走同一发布把关
(见部署与运维 · 备份与迁移)。