Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 2.43 KB

admin_api.md

File metadata and controls

71 lines (56 loc) · 2.43 KB

管理端与观测接口说明

本文档描述了管理端常用 API 以及如何调用同步额度与获取可视化所需的统计数据。

登录与会话

  • 登录页面：GET /v1/admin/login
  • 登录接口：POST /v1/admin/api/login
    • 请求体：{ "username": "admin", "password": "admin" }
    • 响应：{ "success": true, "token": "<bearer>" }
    • 后续调用所有 /v1/admin/api/* 接口，需在 Header 加上：
      • Authorization: Bearer <token>

Token 管理

  • 列表：GET /v1/admin/api/tokens
  • 批量添加：POST /v1/admin/api/tokens/add
    • { "token_type": "sso" | "ssoSuper", "tokens": ["<sso>", ...] }
  • 批量删除：POST /v1/admin/api/tokens/delete
    • { "token_type": "sso" | "ssoSuper", "tokens": ["<sso>", ...] }
  • 设置标签：POST /v1/admin/api/tokens/tags
    • { "token_type": "sso" | "ssoSuper", "token": "<sso>", "tags": ["a", "b"] }
  • 设置备注：POST /v1/admin/api/tokens/note
    • { "token_type": "sso" | "ssoSuper", "token": "<sso>", "note": "..." }
  • 可用性测试：POST /v1/admin/api/tokens/test
    • { "token_type": "sso" | "ssoSuper", "token": "<sso>" }

配置管理

  • 获取配置：GET /v1/admin/api/settings
  • 更新配置：POST /v1/admin/api/settings
    • { "global_config": { ... }, "grok_config": { ... } }

同步额度（重点）

  • 接口：POST /v1/admin/api/tokens/sync
  • 效果：遍历所有 Token，分别查询：
    • 普通额度：grok-4-fast
    • 重载额度（仅 Super）：grok-4-heavy
  • 响应示例：
{
  "success": true,
  "message": "成功刷新 10 / 12 个 Token，其中 2 个 Heavy 额度未同步",
  "data": {
    "total": 12,
    "updated": 10,
    "failed": 0,
    "heavy_failed": 2
  }
}

调用建议：

  • 初次导入 Token 或批量变更后，执行一次同步；
  • 额度周期刷新时，可手动触发同步，让“用量/总额”的展示更准确。

统计与可视化

  • 统计接口：GET /v1/admin/api/stats
  • 响应包含：
    • normal / super / total：池统计（活跃、限流、失效、未同步）
    • usage_per_model：按模型聚合的调用次数（已按倍率折算）
    • limits：聚合的 normal_limit / heavy_limit 以及当前 remaining 总和

可视化建议：

  • 饼图：normal vs super 的 active/limited/expired/unused 占比
  • 柱状图：usage_per_model 按模型对比用量
  • 进度条：聚合 remaining / limit（可分别展示普通与 heavy）