跳转到主要内容
当你通过控制台或 REST API 创建或读取一个 API 密钥时,网关返回 一个令牌对象——持有一个密钥身份、它的限制以及治理其流量的 两个策略附加项的 JSON 记录。本页是那个对象的逐字段参考:每个 字段意味着什么、它的类型,以及携带特殊含义的哨兵值(0-1)。 关于这些字段背后的为什么——最小权限模型——从 限定范围密钥总览 开始。本页是你在编写 密钥创建脚本时保持打开的查找表。

1. 令牌对象参考一览

一个为定时汇总器智能体新创建的密钥看起来像这样:
{
  "id": 4812,
  "name": "support-summarizer-prod",
  "status": 1,
  "key": "sk-orca-a1b2****yz90",
  "created_time": 1733616000,
  "accessed_time": 1733702400,
  "expired_time": -1,
  "unlimited_quota": false,
  "remain_quota": 500000,
  "used_quota": 12340,
  "model_limits_enabled": true,
  "model_limits": "openai/gpt-4o-mini",
  "credit_limit_usd": 25,
  "allow_ips": "203.0.113.7",
  "environment": "prod",
  "guardrail_id": 17,
  "firewall_policy_id": 9,
  "is_firewall_gateway": false,
  "group": "default"
}
key 字段在每一次读取时都被掩码——你看到品牌前缀和最后四个 字符,永远不会看到完整密钥。明文在创建时显示一次。参见 密钥掩码

2. 身份与生命周期字段

这些描述这是哪个密钥,以及它处于生命周期中的什么位置。
密钥的稳定数字标识符。用它来在更新和删除调用中定位密钥。 只读。
密钥的一个人类标签,显示在控制台和日志中。以持有密钥的智能体 来命名密钥——一个密钥,一个智能体。
启用 / 禁用状态。1 意味着活跃;一个被禁用的密钥在认证时被 拒绝而不被删除,因此你可以暂停一个密钥并重新启用它。
持有者密钥,被掩码返回(sk-orca-…****…)。完整值只在创建时 显示一次。把它当作一个密码对待。
密钥被铸造时和它最后一次服务一个请求时的 Unix 时间戳(秒)。 accessed_time 是你判断一个值得吊销的陈旧或未使用密钥的信号。
作为 Unix 时间戳的绝对到期。哨兵值 -1 意味着密钥永不 到期。设置一个真实时间戳以使一个密钥自动到期——这是 CI 运行 和短暂智能体的正确默认值。参见 到期密钥

3. 花费与配额字段

这些限定一个密钥在停止工作之前能消耗多少。
字段类型含义
credit_limit_usdnumber以 USD 计的终身花费上限。0 = 无限。
unlimited_quotaboolean当为 true 时,密钥不对照一个配额余额计量。
remain_quotanumber密钥上剩余的配额。
used_quotanumber迄今消耗的配额。
一个 credit_limit_usd: 0 unlimited_quota: true expired_time: -1 的密钥既无花费天花板也永不到期——一旦泄露便是 最坏的影响半径。何时一个无界密钥是合理的,参见 无限 vs 有界

4. 触及与范围字段

这些限定密钥能触及什么——哪些模型、从哪些地址。
model_limits 是密钥可以调用的模型列表;model_limits_enabled 是开 / 关开关。在限制启用的情况下,一次对任何列表之外模型的 调用会在它离开网关之前被拒绝——智能体无法切换到一个更贵或 能力更强的模型。参见 模型限制
一个 IP / CIDR 允许列表,每行一条条目。一个从任何未列出 地址出示该密钥的请求会在认证层被拒绝;一个值意味着允许 所有地址。参见 IP 允许列表
一个自由格式的部署标签(prodstagingdev,或任何你 选择的),用于组织密钥和过滤日志。纯粹用于组织——它不改变 执行。参见 环境
密钥据以解析模型的路由组。把它保持在工作区默认值,除非你已被 给予一个特定的组。

5. 策略附加字段

密钥上最强大的两个字段。每一个都把密钥绑定到一个治理其流量的 工作区限定策略——更改该策略,附加到它的每个密钥都会在下一次 请求时接收变更,无需重新部署。
字段类型把密钥绑定到
guardrail_idnumber筛查请求和响应文本的一个内容 防护栏
firewall_policy_idnumber治理密钥所发出工具调用的一个 防火墙策略
is_firewall_gatewayboolean把密钥标记为一个面向防火墙 MCP / evaluate 路由的网关限定令牌(不用于推理)。
两个附加项的哨兵值都是 0(未附加)。 但两个平面对一个 被禁用附加项的解析不同:
  • 一个被禁用的 guardrail_id 是关闭开关——该密钥得到 防护栏,且不回退到工作区默认值。
  • 一个被禁用的 firewall_policy_id 回退到工作区默认防火墙 策略。
完整的解析顺序见于 绑定策略范围与密钥
is_firewall_gateway: true 仅为 /api/v1/firewall/* 路由铸造一个 网关限定密钥——永远不要把它放在一个推理密钥上。启用该标志, 以及读取一个网关密钥的明文,都需要 Admin+

6. 设置这些字段

上面的每个字段都在控制台密钥编辑器(/console/token)中配置 ——而非通过一个中继密钥。创建或编辑一个密钥需要 Developer 角色或以上;is_firewall_gateway 标志需要 Admin+
令牌对象是配置表层。密钥的明文sk-orca-…)是你的智能体在 /v1/* 中继调用上出示的东西。在控制台中配置密钥;智能体只看得到 那个密钥。
一个具体的最小权限密钥——在编辑器中设置,回读为上面的对象—— 限定一个模型、一个源 IP 范围、一个每周 USD 天花板、一个到期,以及 一个防护栏加一个防火墙策略。如果持有它的智能体通过 提示注入 被劫持,影响半径 就停在恰好那些边界。

7. 相关参考

限定范围密钥总览

最小权限模型,以及每个密钥字段的中枢。

绑定策略

guardrail_idfirewall_policy_id 如何解析为一个活跃策略。

配额、上限与到期

credit_limit_usdexpired_time 以及配额字段的深度内容。

最小权限检查清单

让每个密钥都经过同样的加固流程。
对这个模型不熟悉?阅读 范围、密钥、策略与工作区 了解令牌对象如何契合工作区 → 策略 → 密钥层级。