跳轉到主要內容
當你透過主控台或 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,以及配額欄位。

最小自主檢查清單

讓每把金鑰都走過同一道硬化流程。
對這個模型陌生?閱讀 範圍、金鑰、政策與工作區 了解權杖物件如何契合工作區 → 政策 → 金鑰的層級。