檢查現有配置
管理員可以通過受管設定、裝置管理或apiKeyHelper 分發閘道地址和認證,因此 Claude Code 在啟動時會自動獲取它們,無需您進行任何設定。要檢查您的組織是否已執行此操作:
啟動 Claude Code
執行
claude。如果它打開登入畫面而不是會話,則未分發閘道認證;自行配置如下。/status 選單中的兩行看起來都正確,但向 Claude 發送的訊息失敗,請參閱故障排除表。
自行配置 Claude Code
要自行為閘道配置 Claude Code,您需要從閘道團隊獲得:- 閘道的基礎 URL
- 認證:金鑰或令牌字符串,或獲取認證的命令
- 如果您的閘道團隊未說明認證的類型,下面的認證變數部分涵蓋了要嘗試的內容
- 設定認證變數和設定基礎 URL:每個閘道連接需要的兩個變數
- 驗證連接:在保存任何內容之前確認它有效
- 配置每個介面:如果您使用除 Claude Code CLI 之外的介面(例如 VS Code),請查看如何使用閘道認證配置它
- 其他配置:某些閘道除了基礎 URL 和認證之外還需要的變數,例如自訂標頭、認證幫助程式、模型發現或提供者格式的基礎 URL。僅在您的管理員命名它們時設定這些
設定認證變數
要向閘道驗證 Claude Code,請在環境變數中設定您的認證。哪個變數取決於您的閘道團隊告訴您的內容:| 在以下位置設定認證 | 使用時機 |
|---|---|
ANTHROPIC_AUTH_TOKEN | 您的閘道團隊說’bearer token’或’Authorization header’ |
ANTHROPIC_API_KEY | 您的閘道團隊說’API key’或’x-api-key’ |
apiKeyHelper | 認證輪換或來自保管庫 |
ANTHROPIC_AUTH_TOKEN;下面的驗證請求顯示如何判斷您是否需要切換。
設定基礎 URL 和認證
將閘道的基礎 URL 和您上面選擇的認證變數設定為環境變數。示例使用ANTHROPIC_AUTH_TOKEN;如果那是您選擇的變數,請將其替換為 ANTHROPIC_API_KEY。您可以在您的 shell 中設定它們(持續一個終端會話),或在 Claude Code 設定檔案中設定它們(在 Claude Code 運行的任何地方持續)。
對於您的第一次連接,從 shell 匯出開始,並在將值移動到設定檔案之前執行驗證請求。
設定為 shell 環境變數
將值替換為您的閘道團隊提供的值:- Bash or Zsh
- PowerShell
~/.zshrc、~/.bashrc 或您的 PowerShell $PROFILE),或改用設定檔案。
在設定檔案中設定
要使配置在 Claude Code 運行的任何地方應用而不依賴於您的 shell,請在設定檔案的env 區塊中設定變數。設定檔案有不同的範圍:
~/.claude/settings.json適用於您的所有專案。在 Windows 上,路徑是%USERPROFILE%\.claude\settings.json.claude/settings.local.json適用於一個專案。Claude Code 在建立檔案時將其添加到您的 gitignore;如果您自己建立它,請先手動將其添加到 gitignore,以免您不小心提交您的認證
env 區塊在任一檔案中看起來都相同:
env 區塊都設定相同的變數時,設定檔案值適用。執行 /status 以查看 Claude Code 使用的基礎 URL 和認證來源。
驗證連接
使用在 shell 中匯出的變數,向閘道直接發送一個單令牌請求。這在您打開 Claude Code 之前確認 URL 和認證有效,因此失敗指向閘道而不是您的配置。下面的命令讀取 shell 變數,因此即使您也將值放在設定檔案中,它們也需要shell 匯出。- Bash or Zsh
- PowerShell
x-api-key 標頭中的金鑰,請在 Bash 命令中將 Authorization 標頭替換為 x-api-key: $ANTHROPIC_API_KEY,或在 PowerShell 命令中將 "Authorization" 雜湊表項目替換為 "x-api-key" = "$env:ANTHROPIC_API_KEY"。
以 {"id":"msg_ 開頭並包含 "content":[...] 欄位的 JSON 回應表示閘道可達且認證有效。命名未知模型的錯誤仍然證明 URL 和認證有效,因為閘道在拒絕模型名稱之前驗證了請求;您不需要為此測試找到您的閘道提供的模型。401 表示認證被拒絕:如果您猜測了變數,請切換到另一個並重新匯出。
在 Claude Code 中確認
從同一 shell 啟動claude,以便它繼承匯出,發送訊息,並執行 /status。
在狀態標籤上,Anthropic base URL 行應顯示您的閘道地址,這確認請求正在路由到那裡;如果該行不存在,變數未到達會話。命名您設定的變數的 Auth token 或 API key 行確認閘道認證處於活動狀態,而不是已保存的 claude.ai 登入。
如果訊息失敗或 /status 未顯示閘道 URL,請參閱下面的故障排除表。
認證變數如何映射到標頭
每個變數在不同的 HTTP 標頭中發送認證:ANTHROPIC_AUTH_TOKEN 在 Authorization: Bearer 中,ANTHROPIC_API_KEY 在 x-api-key 中,apiKeyHelper 在兩者中。錯誤變數中的認證到達閘道時位於它不讀取的標頭中,請求失敗並返回 401。如果驗證請求返回 401,請切換到另一個變數並重試。
與現有登入的衝突
閘道認證變數優先於已保存的 claude.ai 登入或 Console 金鑰。您的 claude.ai 登入在設定變數時保持已保存且未使用;取消設定變數,Claude Code 會回到它。使用ANTHROPIC_AUTH_TOKEN 時,變數立即優先。使用 ANTHROPIC_API_KEY 時,您在互動模式下被提示一次以批准金鑰,然後它接管。
執行 /status 以確認哪個認證來源處於活動狀態。如果啟動顯示命名兩個來源的身份驗證衝突警告,請參閱故障排除表的第一行以了解要刪除哪一個。要清除已保存的登入,以便只有閘道認證保留,請執行 /logout。
配置每個介面
CLI 讀取上面的環境變數和設定檔案。其他介面是 VS Code 擴充功能、桌面應用程式、GitHub Actions、Agent SDK 和雲端介面(例如 Slack 和網頁);下面的部分涵蓋這些設定是否到達每一個。VS Code 擴充功能
在 VS Code 自己的使用者設定中的claudeCode.environmentVariables 中為 VS Code 擴充功能設定閘道變數,使用偏好設定:開啟使用者設定 (JSON) 命令打開。擴充功能在啟動前檢查此設定中的認證,因此這是閘道認證的可靠位置;~/.claude/settings.json 中的值到達生成的程序但不到達擴充功能自己的登入檢查。
桌面應用程式
桌面應用程式從管理員分發的配置讀取閘道路由,而不是從ANTHROPIC_BASE_URL 或 settings.json。如果您的組織已分發它,桌面應用程式通過閘道路由,無需您進行任何設定;如果沒有,請使用終端 CLI 或 VS Code 擴充功能進行閘道會話。管理員按照組織推出中所述分發配置。
如果桌面應用程式顯示 Gateway was unreachable,應用程式在啟動時無法到達配置的基礎 URL;使用上面的 curl 測試檢查 URL 和網路路徑。
GitHub Actions
Claude Code GitHub Actions 從工作流程的env 區塊讀取 ANTHROPIC_BASE_URL 和 ANTHROPIC_CUSTOM_HEADERS。將認證作為操作的 anthropic_api_key 輸入傳遞;操作將其設定為 ANTHROPIC_API_KEY,因此它到達 x-api-key 標頭中的閘道。
對於 x-api-key 閘道,在 env 中設定基礎 URL 並將閘道金鑰作為輸入傳遞:
anthropic_api_key 輸入和工作流程 env 區塊中的 ANTHROPIC_AUTH_TOKEN 傳遞。操作在啟動 Claude Code 之前需要 anthropic_api_key、CLAUDE_CODE_OAUTH_TOKEN 或工作負載身份聯合,並且它不讀取 ANTHROPIC_AUTH_TOKEN,因此輸入滿足該啟動檢查,而 env 變數將金鑰放在閘道讀取的 Authorization 標頭中。x-api-key 中的副本被忽略:
CLAUDE_CODE_OAUTH_TOKEN 和工作負載身份聯合,請參閱 Claude Code GitHub Actions 和操作的 README。
Agent SDK
Agent SDK 沒有閘道特定的選項;它將環境變數傳遞給它生成的 Claude Code 程序。每個 SDK 接受一個env 選項,用於設定生成的程序的環境,TypeScript 和 Python SDK 以不同的方式處理它:
- TypeScript:生成的程序預設繼承父環境,但設定
options.env會完全替換環境。將process.env擴展到其中以保留您的閘道變數。 - Python:
ClaudeAgentOptions(env=...)合併到繼承的環境之上,因此在父程序中設定的閘道變數無需擴展即可通過。
Slack、網頁和遠端控制
Slack 中的 Claude Code 和網頁上的 Claude Code 是 Anthropic 託管的產品,始終使用 Anthropic 的 API;它們不是閘道部署的一部分。在雲端會話的環境配置中設定的閘道變數不適用。如果您的流量必須保留在閘道上,請不要為這些使用者啟用這些介面。 遠端控制和語音聽寫都依賴於 claude.ai 身份:遠端控制將實時會話與您的帳戶配對,語音聽寫到達 claude.ai 轉錄端點。當ANTHROPIC_API_KEY、ANTHROPIC_AUTH_TOKEN 或 apiKeyHelper 處於活動狀態時,它們不可用。要使用任一個,取消設定閘道認證並改用 claude.ai 登入;/doctor 命名要取消設定的變數。
其他配置
這些設定涵蓋超出基礎 URL 和認證的情況。僅在您的管理員的說明或故障排除表要求時設定它們。發送其他標頭
某些閘道使用除認證外的自訂標頭路由或標記請求,例如租戶識別碼或路由金鑰。要發送一個,請設定ANTHROPIC_CUSTOM_HEADERS,每行一個 Name: Value 對。下面的示例添加了一個名為 X-Org-Route 的路由標頭:
- Bash or Zsh
- PowerShell
env 區塊中設定 ANTHROPIC_CUSTOM_HEADERS。在那裡使用 \n 在對之間,因為 JSON 字符串不能跨越多行:
將閘道模型添加到模型選擇器
模型發現在啟動時查詢閘道以獲取其模型列表,並將這些名稱添加到/model 選擇器以及內置項目。
如果您的閘道提供不在 Claude Code 內置列表中的模型名稱,並且您想從選擇器中選擇它們,請啟用它。如果內置模型是您使用的,您不需要發現;您的管理員也可能已通過受管設定啟用它。
要啟用它,請在您的 shell 或 ~/.claude/settings.json 的 env 區塊中設定 CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY=1。發現需要 Claude Code v2.1.129 或更高版本。
發現的模型顯示為標記為 From gateway 的其他 /model 項目。要確認發現已執行,請啟動 claude --debug 並查找 [gatewayDiscovery] 行:成功記錄了多少模型被緩存,404、超時或重定向也被記錄在那裡。有關發現何時執行、它過濾什麼以及閘道提供的回應格式,請參閱模型發現參考。
使用 apiKeyHelper 輪換認證
apiKeyHelper 是 Claude Code 運行以獲取您的閘道認證的命令,而不是從靜態環境變數讀取它。
當認證按計劃過期、來自保管庫或 SSO 命令,或您的管理員告訴您配置一個時,使用幫助程式。如果您的認證是您設定一次的固定字符串,認證變數就是您需要的全部,您可以跳過本部分。
幫助程式是任何將當前認證列印到 stdout 的 shell 命令。Claude Code 通過您的系統 shell 運行它,因此在 Windows 上它可以是可執行檔案或 PowerShell 調用。編寫指令碼,使其可執行,並從您的設定檔案中的 apiKeyHelper 參考它:
- Bash or Zsh
- PowerShell
例如,從保管庫讀取的指令碼:在
~/.claude/settings.json 中參考其路徑:CLAUDE_CODE_API_KEY_HELPER_TTL_MS,例如 CLAUDE_CODE_API_KEY_HELPER_TTL_MS=900000 表示 15 分鐘。
幫助程式的值在 Authorization 和 x-api-key 標頭中都發送,因此無論您的閘道讀取哪個標頭都有效。
通過閘道路由到雲端提供者
這些配置使用提供者特定的基礎 URL 變數代替ANTHROPIC_BASE_URL 將 Claude Code 指向通過閘道的雲端提供者。Bedrock 和 Vertex 閘道接受這些提供者的本機請求格式;Foundry 和 AWS 上的 Claude Platform 閘道接受 Anthropic Messages 格式,僅在哪個基礎 URL 變數到達它們方面有所不同。
僅在您的閘道團隊特別命名 Bedrock、Vertex、Foundry 或 AWS 上的 Claude Platform 時使用一個。如果上面的驗證請求返回 JSON,您可以跳過本部分。
為您的閘道團隊命名的提供者設定區塊。跳過身份驗證變數告訴 Claude Code 不要使用提供者認證簽署請求,因為閘道持有這些。如果閘道需要自己的令牌,請在區塊後添加 ANTHROPIC_AUTH_TOKEN,除了 Foundry,它使用 ANTHROPIC_FOUNDRY_API_KEY,如所示。
Amazon Bedrock
- Bash or Zsh
- PowerShell
Google Vertex AI
- Bash or Zsh
- PowerShell
Microsoft Foundry
將閘道的認證放在ANTHROPIC_FOUNDRY_API_KEY 中;它作為 x-api-key 標頭發送到閘道。CLAUDE_CODE_SKIP_FOUNDRY_AUTH 在這裡不適用:沒有 API 金鑰,Foundry 客戶端在它離開機器之前會使每個請求失敗。
- Bash or Zsh
- PowerShell
AWS 上的 Claude Platform
有關工作區 ID,請參閱 AWS 上的 Claude Platform。- Bash or Zsh
- PowerShell
故障排除閘道錯誤
這些是通過閘道運行 Claude Code 時最常見的錯誤,包括閘道端的原因和修復:| 錯誤 | 原因 | 修復 |
|---|---|---|
啟動警告命名兩個認證來源並以 auth may not work as expected 結尾。較舊的版本顯示 Auth conflict: Both a token (SOURCE) and an API key (SOURCE) are set 代替。 | 閘道認證和已保存的登入都處於活動狀態;變數用於請求,但過時的登入可能導致意外的身份驗證行為 | 取消設定變數以使用已保存的登入,或執行 /logout 以使用閘道認證 |
401 錯誤命名無效或無法識別的令牌 | 認證不是閘道簽發的,或它位於閘道不讀取的標頭中 | 確認變數與認證表中的認證類型匹配,並在閘道處重新生成金鑰(如果已撤銷) |
Unable to connect to API (ConnectionRefused),或來自 npm 安裝的 (ECONNREFUSED),通常在 Claude Code 使用退避重試時無聲暫停後 | 沒有任何東西在基礎 URL 應答:地址錯誤,或 VPN 或防火牆阻止了到閘道的路徑 | 執行上面的 curl 測試,它立即以相同的原因失敗,並與您的閘道團隊確認 URL 和網路路徑 |
API returned an empty or malformed response (HTTP 200) | 閘道或中間代理返回了非 API 回應,通常是 HTML 錯誤或登入頁面 | 使用上面的 curl 請求測試;修復返回非 JSON 的閘道路由 |
400 錯誤命名 context_management、Extra inputs are not permitted 或其他無法識別的欄位 | 閘道將請求轉發到上游,該上游拒絕 Claude Code 發送到 Anthropic 格式端點的欄位 | 設定 CLAUDE_CODE_DISABLE_EXPERIMENTAL_BETAS=1,它抑制大多數預發佈欄位;請參閱功能傳遞。某些 beta 不受此標誌限制;對於那些,設定匹配的 CLAUDE_CODE_USE_* 提供者變數,以便 Claude Code 僅發送該提供者接受的內容 |
400 錯誤命名 thinking 或 adaptive,例如 Input tag 'adaptive' found | 上游模型構建不接受自適應推理,Claude Code 為 Claude 4.6 及更高版本的模型請求 | 升級閘道的上游。在 Opus 4.6 和 Sonnet 4.6 上,CLAUDE_CODE_DISABLE_ADAPTIVE_THINKING=1 改為有效。模型配置功能變數僅適用於提供者配置(例如 CLAUDE_CODE_USE_BEDROCK 和 CLAUDE_CODE_USE_VERTEX),不在 ANTHROPIC_BASE_URL 閘道後面 |
400 錯誤陳述閘道自己的詞語中的上下文或令牌限制,例如 ContextWindowExceededError 或 prompt token count of N exceeds the limit of M | 閘道強制執行比模型的本機視窗更小的上下文,並重寫上游錯誤,因此自動壓縮和重試(與 Anthropic 的 prompt is too long 措辭匹配)不會觸發 | 執行 /compact 以恢復會話。要防止它,請將 CLAUDE_CODE_AUTO_COMPACT_WINDOW 設定為閘道的限制;該值被限制在至少 100,000 令牌和最多模型的上下文視窗,因此低於 100,000 的閘道限制無法匹配,/compact 在那裡仍然是恢復。還要將 CLAUDE_CODE_MAX_OUTPUT_TOKENS 設定為低於閘道模型的輸出限制 |
模型缺失於 /model 選擇器 | 閘道模型名稱不在 Claude Code 的內置列表中 | 啟用閘道模型發現或使用模型配置變數添加名稱 |
| Claude Code 要求您登入,儘管 curl 測試成功 | CLI 沒有自己的認證:可達的基礎 URL 不是一個,專案的 .claude/settings.json 或 .claude/settings.local.json 中的 env 區塊僅在首次執行嚮導和信任提示後應用 | 在 Claude Code 在首次執行設定之前讀取的位置設定 ANTHROPIC_AUTH_TOKEN:shell 匯出、~/.claude/settings.json 中的 env 區塊或受管設定 |
ANTHROPIC_API_KEY 已設定但被忽略,無提示 | 金鑰在互動會話中需要一次性批准,之前拒絕的金鑰被忽略而不再詢問 | 使用 Use custom API key 選項在 /config 下啟用它 |
This machine's managed settings require a first-party login | 受管設定包括 forceLoginMethod 或 forceLoginOrgUUID,在 Claude Code v2.1.146 及更高版本上不能與 ANTHROPIC_API_KEY、ANTHROPIC_AUTH_TOKEN 或 apiKeyHelper 共存 | 您的管理員必須從受管設定中移除 forceLoginMethod 和 forceLoginOrgUUID 以使用閘道認證,或移除閘道認證以使用第一方登入。兩者無法結合 |
403 帶有 HTML 正文,例如 403 Forbidden,當閘道自己的日誌顯示未收到請求時 | 閘道前面的網頁應用程式防火牆或反向代理在到達閘道之前阻止了請求正文。Claude Code 提示包括 XML 樣式標籤和與跨站點指令碼正文規則匹配的原始程式碼,因此短 curl 測試通過而實際會話不通過 | 豁免閘道的 /v1/messages 路徑免受請求正文檢查。在 AWS WAF 上,這是 CrossSiteScripting_Body 受管規則;在帶有 ModSecurity 的 nginx 上,它是等效的 OWASP CRS 正文規則 |
憑證或 TLS 錯誤,例如 SSL certificate verification failed 或 Self-signed certificate detected,當 curl 測試成功時 | Claude Code 的執行時不信任 curl 使用的相同憑證授權。在公司 TLS 檢查代理後面很常見 | 將 NODE_EXTRA_CA_CERTS 設定為 CA 束路徑;請參閱 CA 憑證存儲 |
相關資源
- LLM 閘道概述:什麼是閘道以及它如何與 claude.ai 訂閱互動
- 為您的組織推出 LLM 閘道:部署和分發閘道配置的面向管理員的檢查清單
- 閘道協議參考:Claude Code 發送到閘道的內容,包括閘道必須轉發的標頭和欄位
- 設定:設定檔案的位置以及如何讀取
env區塊 - 身份驗證:認證變數、
apiKeyHelper和 OAuth 登入如何互動