跳到主要内容

Admin API 管理

自托管网关会为管理流量和应用流量暴露不同的本地监听器。

可以使用 Admin API 创建和更新 AISIX 处理应用流量时读取的资源：

在基础请求链路中，这些资源包括服务提供方密钥、模型别名和调用方 API Key。Admin 变更是动态生效的，因此可以在不重启网关的情况下更新它们。

访问 Admin API​

Admin API 运行在启动时配置的 Admin 监听器上。下面示例中，该监听器地址为 http://127.0.0.1:3001。

Admin 认证属于静态启动配置。Admin Key 来自 config.yaml 中的 admin.admin_keys，并且与调用方 API Key 相互独立。

在 config.yaml 中至少配置一个 Admin Key：

config.yaml
admin:
  addr: "0.0.0.0:3001"
  admin_keys:
    - "admin-local-only-change-me"

本地测试时可以使用示例密钥。共享环境或生产环境中，请替换为强密钥，尽可能将 Admin 监听器限制在私有网络或 loopback 接口，并且不要把代理侧调用方 API Key 复用为 Admin Key。由于 Admin Key 属于启动配置，轮换时应通过部署或配置管理流程完成。

将 AISIX_ADMIN_KEY 设置为已配置的某个 Admin Key，然后发送一个最小 Admin 请求：

export AISIX_ADMIN_KEY="admin-local-only-change-me"

curl -sS "http://127.0.0.1:3001/admin/v1/models" \
  -H "Authorization: Bearer ${AISIX_ADMIN_KEY}"

Admin API 管理的内容​

确认可以访问 Admin API 后，就可以用它创建构成请求链路的资源。

服务提供方密钥用于保存上游凭证和端点设置。模型用于定义面向调用方的别名，并将其映射到上游模型或路由目标。调用方 API Key 用于认证调用方，并控制它们可以使用哪些模型别名。

其它资源会围绕同一条链路添加策略和遥测行为，例如安全护栏、缓存策略和可观测性导出器。

可以从你需要配置的资源开始，例如服务提供方密钥、模型或 API Key。当需要查看准确端点、请求 schema、响应 schema、状态码或错误字段时，请使用 Admin API 参考。

下一步​

你已经了解 Admin API 如何融入自托管请求链路。接下来可以继续阅读服务提供方凭证、模型别名和调用方 API Key，构建第一条流量链路。