API Gateway:キーの参照

前提条件

キーを作成しておく必要があります。キーの作成の詳細については、「キーの作成」をご参照ください。

コンシューマーでのキーの参照

1. AI ゲートウェイコンソールに移動します。左側のナビゲーションウィンドウで、[コンシューマー] を選択します。上部のメニューバーで、リージョンを選択します。

2. [コンシューマーの作成] をクリックします。[コンシューマーの作成] パネルで、コンシューマーの名前を入力します。[認証方式] を [API キー] に、[生成方法] を [キーの参照] に設定します。次に、[キーのバインド] を既存のキーに設定します。

   説明

   コンシューマー認証情報のキー参照は、API キー認証方式を使用する場合にのみサポートされます。

AI サービスでのキーの参照

1. AI Gateway コンソールに移動します。左側のナビゲーションウィンドウで、[インスタンス] を選択します。上部のメニューバーで、リージョンを選択します。

2. 対象インスタンスの ID をクリックします。左側のナビゲーションウィンドウで [サービス] を選択し、[サービスの作成] をクリックします。

3. [サービスの作成] パネルで、[サービスソース] を [AI サービス] に設定します。[大規模モデル設定] セクションで、[生成方法] を [キーの参照] に設定します。次に、[API-KEY] を既存のキーに設定します。

Agent サービスでのキーの参照

1. AI Gateway コンソールに移動します。左側のナビゲーションウィンドウで、[インスタンス] を選択します。上部のメニューバーで、リージョンを選択します。

2. 対象インスタンスの ID をクリックします。左側のナビゲーションウィンドウで [サービス] を選択し、[サービスの作成] をクリックします。

3. [サービスの作成] パネルで、[サービスソース] を [Agent サービス] に設定します。[生成方法] を [キーの参照] に設定します。次に、[API-KEY] を既存のキーに設定します。

MCP サービスでのキーの参照

AI ゲートウェイによって直接プロキシされる MCP サービスは、バックエンド認証をサポートします。認証構成では、既存のキーを認証情報として指定できます。

1. AI Gateway コンソールに移動します。左側のナビゲーションウィンドウで、[インスタンス] を選択します。上部のメニューバーで、リージョンを選択します。

2. 対象インスタンスの ID をクリックします。[MCP 管理] をクリックします。次に、直接プロキシのシナリオ用に MCP サービスを作成します。詳細については、「ゲートウェイホスト型 MCP サービスの作成」をご参照ください。

3. MCP サービスの詳細ページに移動します。[基本情報] ページで [バックエンドサービス認証の設定] をクリックし、以下の設定を行って認証を有効にします。

   1. 認証方式: [API キー] を選択します。

   2. 認証情報ソース: [カスタム HTTP ヘッダー]。

   3. ヘッダー: 認証情報を伝達するヘッダーの名前。

   4. 生成方式: [キーの参照] を選択します。

   5. 認証情報: 既存のキーを選択します。

プラグインでのキーの参照

プラグイン構成では、$ref{secretName} 構文を使用してキーを参照できます。ここで、secretName はキーの名前です。次のコードは、Key-Auth プラグインの構成例です。

credentials: 
# secretName という名前のキーを参照
- $ref{secretName}
keys:
- apikey
- x-api-key

この構成では、secretName キーを使用して AI ゲートウェイにアクセスできます。公式プラグインとカスタムプラグインの両方でキーの参照がサポートされています。

キー参照の詳細の表示

AI Gateway コンソールに移動します。左側のナビゲーションウィンドウで、[キー] を選択します。[参照元] 列で、キーの番号をクリックすると、そのキーを参照しているリソースが表示されます。