Skip to content

API 概览

本目录记录面向 Dashboard、外部管理系统和兼容调用方的 HTTP API。内部 Agent/SDK 链路不以 REST 文档为准,应参考 架构总览SDK Wire Protocol

API 类型

类型说明协议
REST API面向 Dashboard 与外部管理调用HTTP / HTTPS
Session Wire APISDK 与 Agent、Agent 与 Server 之间的内部协议TCP session,可按链路启用 TLS

REST API

REST API 用于:

  • Dashboard 管理界面
  • 外部系统集成
  • 查询与配置操作

基础路径: /api/v1/

认证方式: JWT Bearer Token

Canonical 文档规则

API 文档当前处于收敛期。新增或修改接口时按以下规则维护:

  • 路由清单以 internal/handler/routes.go 为准(生效注册);文档与代码不一致时修文档。
  • 每个业务域只保留一个 canonical 页面,例如函数域使用 函数 API,任务域使用 任务 API
  • 兼容历史调用的页面必须在标题或正文标明“兼容”,例如 函数调用兼容 API
  • ops.md 是运维域当前主入口,ops_core.mdops-simple.md 保留为拆分/兼容参考,不能新增独立语义。
  • Analytics 的 HTTP API 页面保留在本目录,分析系统设计和指标说明保留在 Analytics 文档

主要接口分类

分类Canonical 文档
认证与基础认证 APIREST 契约Schema API元数据 API
核心业务游戏 API玩家 API函数 API函数元数据注册任务 API消息 API配置 API
审批与审计审批 API审计 API
页面产品域页面与控制台 API(Proposal / Pages / Versioning / Console)、Resource Catalog APIOpenAPI 注册
运维与平台运维 APIAgent API节点 API注册表 API平台 APIProvider API
数据分析数据分析 API分析概览 API行为分析 API留存分析 API支付分析 API
控制台域管理员 APIProfile API
运营支持分配 API工单 API反馈 API支持 APIFAQ
系统能力存储 API备份 API迁移 API监控 API证书 API限流 API告警 API

兼容页

以下页面存在是为了兼容历史调用或拆分过渡,不应作为新功能设计入口: