管理员创建 Key

在管理控制台创建和管理 API Key,用于 API 请求的身份验证与权限控制

说明:API Key 是调用 AI Gateway 接口的身份凭证,创建后会通过邮箱发送给使用者。请妥善保管,不要泄露给他人。

前置准备:创建 API Key 前需要完成以下两项配置:

  1. 先完成 Token 供应商配置。请参考 Token 供应商配置文档。Token 供应商配置
  2. 在「系统设置」→「域名管理」中配置并启用至少一个域名。系统会在创建 Key 时校验是否有可用域名,未配置域名将无法创建 Key。域名管理

Key 管理列表

1

进入 Key 管理页面

完成前置配置后,在左侧导航栏中选择「网关管理」→「Key 管理」,进入 Key 管理列表页面。

统计概览

页面顶部展示四张统计卡片,帮助您快速了解当前 Key 的整体状态:

活跃 Key 数量

活跃 Key 数量

正常使用的 Key

正常使用的 Key

接近或超过配额的 Key

接近或超过配额的 Key

被禁用的 Key 数量

被禁用的 Key 数量

Key 管理列表

图 3:Key 管理列表页面,展示所有已创建的 Key 及其状态

图 3:Key 管理列表页面,展示所有已创建的 Key 及其状态

列表字段说明

字段说明
Key 名称用户自定义的 Key 名称,下方显示脱敏后的 Key 前缀和后 4 位
供应商该 Key 绑定的 Token 供应商名称,支持绑定多个供应商
绑定类型「个人」或「应用」。个人 Key 绑定到具体用户,应用 Key 绑定到应用程序
Key 后缀Key 的后 4 位字符,用于快速识别
使用量展示今日使用量 / 日配额,以及使用百分比进度条。超过 80% 进度条变黄色
状态绿色「启用」、灰色「已禁用」、橙色「日额度告警 / 月额度告警」、红色「已过期」
操作复制 Key、编辑、重置 Key、删除、启用/禁用

搜索与筛选

  • 名称搜索:输入 Key 名称关键字搜索
  • 状态筛选:筛选「正常」或「已禁用」
  • 绑定类型筛选:筛选「用户」或「应用」
  • 点击「重置」按钮可清空所有筛选条件

创建 API Key

1

打开创建表单

点击列表页面右上角的「创建 Key」按钮,从右侧滑出抽屉式表单窗口。创建前系统会自动检查是否已配置并启用了域名,若未配置会提示前往域名管理页面。

2

填写 Key 基本信息

创建 Key 表单包含以下字段:

字段必填说明
Key 名称自定义名称,用于区分不同用途的 Key
有效期设置 Key 的可用截止日期,过期后自动失效
绑定供应商选择一个或多个 Token 供应商,该 Key 可调用这些供应商的模型
绑定类型「个人」或「应用」。个人 Key 绑定到具体用户,应用 Key 绑定到应用程序
3

个人模式 — 绑定用户信息

选择「个人」类型时,需要填写以下额外信息,每个用户只能创建一个个人 Key:

字段必填说明
姓名使用者姓名
邮箱接收 Key 明文的邮箱地址
3

应用模式 — 高级配置

选择「应用」类型时,支持更丰富的访问控制配置:

  • 是否按用户统计: 开启后,每个终端用户的用量独立统计,需要请求携带 JWT 用户信息
  • 允许的访问域名: 设置允许使用该 Key 的邮箱域名白名单,仅匹配域名的请求可通过
  • 日 Token 额度: 每个终端用户每日的 Token 用量上限
  • 月 Token 额度: 每个终端用户每月的 Token 用量上限
4

配置速度管控

个人模式和应用模式都需要配置速度管控参数,RPM 和 TPM 默认值取自系统额度配置。

字段必填说明
RPM该 Key 每分钟允许的最大 API 请求数
TPM该 Key 每分钟允许的最大 Token 消耗量,单位为 M(百万)

额度与速度管控

5

确认创建

填写完所有必填信息后,点击「确定」按钮,系统将生成新的 API Key。创建成功后,新 Key 会出现在 Key 列表中,Key 明文会自动发送至填写的邮箱地址。

打开创建表单

图 4:创建 Key 表单(个人模式),填写 Key 名称、有效期、供应商、类型、姓名、邮箱、RPM、TPM

图 4:创建 Key 表单(个人模式),填写 Key 名称、有效期、供应商、类型、姓名、邮箱、RPM、TPM

Key 管理操作

在 Key 列表中,您可以对每个 API Key 执行以下操作:

复制 Key

点击「复制 Key」按钮,系统从后端获取 Key 明文并复制到剪贴板。注意:此操作受租户权限控制,管理员可关闭复制 Key 功能。

编辑

点击「编辑」从右侧打开抽屉,可修改 Key 的名称、有效期、供应商、RPM、TPM 等配置。类型(个人/应用)不可修改。编辑模式下可输入新的 API Key 替换原 Key。

重置 Key

当 Key 可能泄露时,点击「重置 Key」生成新的 Key 明文,原 Key 将立即失效。操作前需确认弹窗,重置成功后新 Key 自动复制到剪贴板。

启用 / 禁用

可随时禁用或启用 Key。禁用的 Key 立即停止响应 API 请求,需确认弹窗后执行。已禁用的 Key 操作列会显示「启用」按钮。

删除

永久删除该 Key,删除后不可恢复,操作前需确认弹窗,请谨慎操作。