API Gateway：引用密鑰

前提條件

已建立密鑰，如尚未建立密鑰，參考建立密鑰。

在消費者中引用密鑰

1. 前往 AI 網關控制台，在左側導覽列選擇消費者，在頂部功能表列選擇地區。

2. 單擊建立消費者，在建立消費者頁面，配置消費者名稱，認證方式選擇 API Key，產生方式選擇引用密鑰，在綁定密鑰選項中選擇已有密鑰。

   說明

   消費者憑證資訊中僅 API key 認證方式支援引用密鑰。

在 AI 服務中引用密鑰

1. 前往 AI 網關控制台，在左側導覽列選擇執行個體，在頂部功能表列選擇地區。

2. 單擊目標執行個體 ID，選擇左側導覽列服務，然後單擊建立服務。

3. 在建立服務面板中，服務來源選擇AI服務，在大模型配置中，產生方式選擇引用密鑰，API Key 選擇已有密鑰。

在 Agent 服務中引用密鑰

1. 前往 AI 網關控制台，在左側導覽列選擇執行個體，在頂部功能表列選擇地區。

2. 單擊目標執行個體 ID，選擇左側導覽列的服務，然後單擊建立服務。

3. 在建立服務面板中，服務來源選擇Agent 服務，產生方式選擇引用密鑰，API Key 選擇已有密鑰名稱。

在 MCP 服務中引用密鑰

AI 網關直接代理的 MCP 服務支援開啟後端認證，在認證配置中，可將憑證直接指定為已有密鑰。

1. 登入 AI 網關控制台，在左側導覽列選擇執行個體，在頂部功能表列選擇地區。

2. 單擊目標執行個體 ID，建立使用情境為MCP服務直接代理的 MCP 服務，參考：建立網關託管MCP服務。

3. 進入 MCP 服務詳情頁，在基本資料頁單擊配置後端服務憑證開啟認證狀態，參考以下內容完成相關配置。

   1. 認證方式：選擇 API Key。

   2. 憑證來源：自訂 HTTP Header。

   3. Header：攜帶憑證的 Header 名稱。

   4. 產生方式：選擇引用密鑰。

   5. 憑證：選擇已有的密鑰名稱。

在外掛程式中引用密鑰

在外掛程式配置中，可以使用$ref{secretName}文法引用已建立的密鑰，其中secretName為密鑰名稱，下面是 Key-Auth 外掛程式的配置樣本：

credentials: 
# 引用名為secretName的密鑰
- $ref{secretName}
keys:
- apikey
- x-api-key

通過上述配置，可直接使用secretName密鑰訪問 AI 網關，官方外掛程式與自訂外掛程式均支援引用密鑰。

查看密鑰的引用詳情

前往 AI 網關控制台，在左側導覽列選擇密鑰，在被引用列點擊密鑰的引用次數，可查看當前密鑰被哪些資源引用。