跳到主要内容
版本:1.8.0

AISIX Enterprise / Cloud Admin API 参考

AISIX Enterprise 与 AISIX Cloud 使用同一个面向组织范围自动化的公开 Admin API。正式公开名称为 AISIX Cloud Admin API。大多数操作适用于两种产品;仅适用于某一产品的操作会在接口说明中标明可用范围。该 API 管理环境、模型、调用方 API Key、服务提供方密钥、MCP 服务器、组织成员和基于角色的访问控制,不覆盖控制台或服务内部使用的全部 HTTP 路由。

完整的接口参考由控制面的 OpenAPI 源自动生成,并发布在英文文档站。本页入口固定为 1.8.0,不会随“最新发布版本”移动。请使用与你运行版本匹配的契约;其他版本可能提供不同操作或字段。

接口参考​

版本变更与历史版本​

升级前,请查看版本变更对照。它列出相邻发布版本之间新增和删除的端点、请求与响应字段、枚举值及必填项,并将影响调用方的变更标记为 Breaking。同一页面还提供历史版本的完整参考入口。

每个版本的具体变更也会记录在该版本发布说明的“API 变化”一节。

备注

接口参考的字段说明目前仅提供英文版本。端点路径、字段名和枚举值保持契约原文,可以对照本站对应版本的中文指南使用。

认证​

通常使用组织级 Admin Token 认证。通过该 Token 执行写操作需要写权限。例外是 POST /data_import:它用于恢复 AISIX Enterprise,需要已登录的 AISIX Enterprise 控制台会话,而不是组织级 Admin Token。请按对应版本接口说明满足恢复前提条件。

已记录的 JSON 错误响应使用 {"error": {"code": "...", "message": "..."}} 信封。在某产品不提供某项操作时,如果该版本的 404 响应未声明此信封,可能返回不带该 JSON 信封的 404。不要假设任意 404 都包含可解析的 error.code。

创建和管理 Admin Token 的方法请参阅 Admin Token。