Skip to content

网关管理 / API 密钥管理 ​

「API 密钥管理」管理平台用户的调用凭证,可创建、导入密钥,查看每个密钥的状态、归属消费者与可访问模型,并启用或禁用密钥。为用户签发调用凭证、排查调用鉴权失败,或停用泄露的密钥时使用这一页。

前提条件 ​

  • 已登录 Boss 管理侧。
  • 账号具备「网关管理」>「API 密钥管理」的查看权限;创建与导入需要对应的管理权限。
  • 目标消费者已存在,即对应平台用户已创建。

界面说明 ​

API 密钥管理

截图采集于 2026-11-02,环境:开发环境。

页面标题为「网关管理 / API 密钥管理」,说明为「管理用户的 API KEY,支持查看模型调用权限,可启用或禁用 API Key。」。

筛选区左侧为「搜索名称、完整密钥或…」输入框,其后是「消费者」「状态」「来源」三个筛选按钮;右侧依次为蓝色「创建」、「导入」、「列显隐」和「刷新」。

表格字段如下:

列说明截图示例
API 密钥名称密钥名称666、admin-003、cs-test-wb-key1
状态密钥是否可用「已启用」「用户已禁用」「管理员已禁用」
描述密钥用途说明,未填时为「-」test、ljl测试
消费者密钥归属的调用方admin、test-wq-wq-2
API Key脱敏后的密钥值需横向滚动查看
来源密钥的创建途径需横向滚动查看
创建时间密钥创建时间需横向滚动查看
到期时间密钥到期时间需横向滚动查看
操作行内操作入口「可访问模型」「更多操作」

截图中「cs-test-wb-key1」的状态为「用户已禁用」,其「可访问模型」为灰色不可点,说明消费者被禁用后无法再调整该密钥的模型权限。列表底部显示「共 1085 条」,每页可选「10 条/页」,当前第 1 页、共 109 页。

单击「创建」后从右侧滑出「创建密钥」抽屉,说明为「签发给平台用户;明文只在创建成功时展示一次。」。

创建密钥

截图采集于 2026-11-02,环境:开发环境。

抽屉字段如下:

字段说明
用户名*密钥归属的平台用户,下拉选择
API 密钥名称*密钥名称
描述密钥用途说明,多行文本
有效期密钥有效时长,截图中为「永不过期」

抽屉底部为「取消」和蓝色「确定」。工具栏的「导入」用于批量导入已有密钥,入口与本页其他按钮并列。

操作步骤 ​

创建密钥

  1. 在左侧导航选择「网关管理」>「API 密钥管理」。
  2. 单击工具栏右侧的「创建」。
  3. 在抽屉中选择「用户名」,填写「API 密钥名称」与「描述」。
  4. 按需选择「有效期」,单击「确定」;创建成功后立即复制明文,明文只展示一次。

按条件检索密钥

  1. 在「搜索名称、完整密钥或…」中输入密钥名称或完整密钥。
  2. 单击「消费者」「状态」「来源」中的任一筛选按钮收窄结果。
  3. 查看「消费者」列确认归属,查看「状态」列确认是否可用。
  4. 需要恢复全量列表时清空搜索框并重新选择筛选条件。

调整可访问模型

  1. 在目标行单击「可访问模型」。
  2. 在打开的界面中选择该密钥允许调用的模型。
  3. 保存后回到列表,核对「状态」仍为「已启用」。

结果验证 ​

  • 创建成功后列表出现新记录,「消费者」为所选用户,状态为「已启用」。
  • 创建结果弹窗中显示一次密钥明文,关闭后列表中「API Key」只显示脱敏值。
  • 状态筛选为「管理员已禁用」时,列表只剩被管理员停用的密钥。
  • 调整可访问模型后,该密钥的调用范围按新配置生效。

详情页 ​

功能说明 ​

在「API 密钥管理」列表中单击某一行的「可访问模型」,弹出「可访问模型」窗口,标题下方显示该密钥的名称。窗口列出这把密钥当前可以调用的 AI 路由,以及每条路由的路径、模型分类、模型名称、上游服务与是否需要认证。需要确认某个密钥能调用哪些模型、核对路由与上游的对应关系,或排查「密钥已授予权限却调用失败」时使用这个窗口。

界面说明 ​

可访问模型

截图采集于 2026-11-03,环境:开发环境。

窗口顶部为标题「可访问模型」与密钥名称(截图为 666),右上角为关闭图标。

标题下方为筛选区:左侧「AI 路由」输入框与「模型名称」输入框,其后是「模型分类」「上游服务」两个带图标的筛选按钮;最右侧为「列显隐」图标,用于控制表格列的显示与隐藏。

表格字段如下:

列说明截图示例
「AI 路由」密钥可调用的路由名,右侧有复制图标demo-smart、higress-auto
「路径」路由对外暴露的请求路径/smart、/v1/images/gen…
「模型分类」路由处理的模型类别,未分类显示「-」对话、生图、决策、分词
「模型名称」路由对应的模型标识,右侧有复制图标auto、private-qwen3-32b、*
「上游服务」请求最终转发到的上游服务,右侧有复制图标Ascend 112 私有 Qwen3 8B、TypeSafe Jev
「需认证」调用该路由是否还要求额外认证否、是

截图中「issue4360-classifier」一行「需认证」为「是」,其余各行为「否」。「路径」与「上游服务」较长时以省略号截断,需要完整值可复制。

窗口底部左侧显示「共 32 条」与「10 条/页」选择器,右侧为翻页控件(截图为「1」「2」「…」「4」与上一页、下一页),右下角为「关闭」按钮。

操作步骤 ​

按路由或模型检索

  1. 在「API 密钥管理」列表中单击目标密钥行的「可访问模型」。
  2. 在「AI 路由」输入框中输入路由名关键字。
  3. 在「模型名称」输入框中输入模型标识,两个输入框可同时使用。

按分类与上游筛选

  1. 单击「模型分类」,选择要查看的模型类别。
  2. 单击「上游服务」,选择目标上游。
  3. 需要恢复全量列表时清空输入框并重新选择筛选项。

复制字段值

  1. 在目标行的「AI 路由」「模型名称」或「上游服务」后单击复制图标。
  2. 将复制的值粘贴到调用配置或排查记录中。

关闭窗口

  1. 核对完模型清单后单击右下角「关闭」,或单击右上角关闭图标。

结果验证 ​

  • 窗口标题下方显示的名称与列表中所选行的「API 密钥名称」一致。
  • 筛选后表格只保留匹配的路由,底部「共 N 条」随条件变化。
  • 翻页后表格内容更新,页码保持高亮,回到第 1 页可看到首条记录。
  • 复制的值与表格中显示的「AI 路由」「模型名称」「上游服务」一致。

注意事项 ​

  • 本窗口只用于查看,不提供授权或取消授权的入口。
  • 「需认证」为「是」的路由在调用时还需额外的认证信息,仅有密钥不足以直接调用。
  • 「路径」与「上游服务」在列宽不足时被截断,判断完整地址时使用复制图标取值。
  • 密钥状态为「用户已禁用」或「管理员已禁用」时,列表中的「可访问模型」入口为灰色不可点。
  • 窗口中的清单是密钥当前的授权结果,路由侧调整后需重新打开窗口查看。

注意事项 ​

  • 密钥明文只在创建成功时展示一次,关闭后无法再次查看,需当场复制保存。
  • 状态为「用户已禁用」时,需先在用户管理恢复该用户;「管理员已禁用」由管理员操作产生。
  • 被禁用的密钥不能用于调用,其「可访问模型」入口为灰色。
  • 密钥等同于账号凭证,不要写入公开代码仓库或截图外传。
  • 「更多操作」中的条目未展开时不显示,删除类操作执行前确认没有业务仍在使用该密钥。

相关操作 ​