API Gateway:参照キー

前提条件

既存のキーが必要です。キーがない場合は、キーの作成 の説明に従って作成してください。

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

1. AI Gateway コンソールに移動します。 ナビゲーションペインで、Consumers を選択します。 上部のメニューバーで、リージョンを選択します。

2. Create a consumer をクリックします。 [コンシューマーの作成] ページでコンシューマー名を入力します。 認証方法を [API キー] に、生成方法を [キーの参照] に設定し、[バインドキー] で既存のキーを選択します。

   説明

   コンシューマーの認証情報では、キー参照をサポートしているのは API キー認証方法のみです。

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

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

2. ターゲットインスタンスの ID をクリックします。 ナビゲーションペインで Service を選択し、Create Service をクリックします。

3. Create Service パネルで、[サービスソース] を [AI サービス] に設定します。 Large Model Configuration セクションで、生成方法を [キーの参照] に設定し、[API キー] で既存のキーを選択します。

エージェントサービスでのキーの参照

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

2. ターゲットインスタンスの ID をクリックします。 ナビゲーションペインで Service を選択し、Create Service をクリックします。

3. Create Service パネルで、[サービスソース] を [エージェントサービス] に、[生成方法] を [キーの参照] に設定し、[API キー] で既存のキーを選択します。

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

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

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

2. ターゲットインスタンス ID をクリックし、ゲートウェイホスト型 MCP サービスの作成 の説明に従って、ダイレクトプロキシシナリオ用の MCP サービスを作成してください。

3. MCP サービスの詳細ページで、[基本情報] の Configure Backend Service Authentication をクリックして認証を有効にし、次の設定を行います。

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

   2. 認証情報ソース： [カスタム HTTP ヘッダー] を選択します。

   3. ヘッダー： 認証情報を伝送するヘッダー名を指定します。

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

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

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

プラグイン設定でキーを参照するには、$ref{secretName} 構文を使用します。ここで、secretName はキー名です。 Key-Auth プラグインの設定例：

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

この設定では、secretName キーが AI Gateway へのアクセスを認証します。 公式プラグインとカスタムプラグインの両方でキー参照がサポートされています。

キー参照の表示

AI Gateway コンソールに移動します。 ナビゲーションペインで キー を選択します。 Referenced 列で、キーの参照数をクリックすると、そのキーを使用しているリソースを確認できます。