API プロキシのチェーン接続

このページの内容は Apigee と Apigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示する。

あるプロキシが別のプロキシのターゲットエンドポイントになるように指定できます。これにより、事実上、プロキシチェーンで 2 つのプロキシを接続することになります。このようにプロキシをチェーンで接続すると、ネットワークホップが回避されるため、全体のパフォーマンスが向上します。

プロキシチェーンでは、あるプロキシがもう一方のプロキシのローカルターゲットエンドポイントになるように指定します。HTTPTargetConnection 要素を使用して 2 番目のプロキシを呼び出すのではなく、LocalTargetConnection 要素を使用します。

<LocalTargetConnection>
    <APIProxy>myproxy2</APIProxy>
    <ProxyEndpoint>default</ProxyEndpoint>
</LocalTargetConnection>

プロキシチェーンは、他のプロキシが利用する個別の詳細レベルの機能を提供するプロキシが存在する場合に役立つことがあります。たとえば、バックエンドデータストアを使用して create/read/update/delete オペレーションを公開するプロキシは、データをクライアントに公開する他の複数のプロキシのターゲットプロキシになることがあります。

注: この方法で接続するプロキシは、同じ組織と環境に属している必要があります。接続しようとしているプロキシがこの範囲内にない場合は、HTTPTargetConnection 要素を使用して、外部リソースとして接続する方法を検討してください（API プロキシ構成リファレンスを参照）。

動画: API プロキシチェーンについて詳しく説明する短い動画をご覧ください。

プロキシチェーンの動作

プロキシチェーンでは、ローカル接続を使用して、あるプロキシを別のプロキシから呼び出す場合のネットワークオーバーヘッドを最小限に抑えます。このローカル接続は、ロードバランサ、ルーター、メッセージプロセッサなどのネットワーク機能を迂回するため、より効率的です。

HTTPTargetConnection と LocalTargetConnection（プロキシチェーン接続）でプロキシを接続する場合の違いを以下に示します。

プロキシチェーン接続なしのプロキシ間呼び出しの図。

プロキシチェーン接続でのプロキシ間呼び出しの図。

一方が他方のローカルターゲットエンドポイントになるように指定して、プロキシを接続します。上の図の構成（プロキシチェーン接続を使用したプロキシ間の呼び出し）では、ProxyB（/proxyB）を ProxyA（/proxyA）のローカルターゲットエンドポイントに指定します。これにより、ProxyA に到着したリクエストが ProxyB に転送されます。

プロキシ間のローカル接続は、次の 2 つの方法で作成できます。

ターゲットプロキシの名前と ProxyEndpoint 名を指定する
ターゲットプロキシエンドポイントへのパスを指定する。

以下に説明するように、TargetEndpoint 構成内で LocalTargetConnection 要素を使用して、ターゲットプロキシを接続します。

プロキシ名によるプロキシの接続

ターゲットプロキシは名前によって指定できます。接続をゼロから作成し、プロキシをまとめて開発する場合、この方法が最も便利である可能性があります。名前がわからない場合（または名前が変わる可能性がある場合）は、以下で説明するような、ターゲットプロキシのエンドポイントパスへの接続を検討してください。

名前でターゲットプロキシに接続する場合は、プロキシの名前とその ProxyEndpoint の名前を指定します。

以下の例では、data-manager というターゲットプロキシと、data-manager によって公開される ProxyEndpoint 名を指定しています。詳細については、API プロキシ構成リファレンスをご覧ください。

<APIProxy> 要素と <ProxyEndpoint> 要素は、メッセージテンプレートと呼ばれる動的文字列置換機能をサポートしています。

<TargetEndpoint name="datamanager">
    <PreFlow name="PreFlow">
        <!-- PreFlow policies -->
    </PreFlow>
    <PostFlow name="PostFlow">
        <!-- PostFlow policies -->
    </PostFlow>
    <LocalTargetConnection>
        <APIProxy>data-manager</APIProxy>
        <ProxyEndpoint>default</ProxyEndpoint>
    </LocalTargetConnection>
</TargetEndpoint>

パスによるプロキシの接続

ターゲットプロキシはそのエンドポイントパスによって指定できます。プロキシ名がわからない場合や、名前が変わる可能性がある場合に、この方法を使用することをおすすめします。

プロキシがターゲットプロキシの利用者にすぎない場合（両方を開発していない場合など）、パスが最も信頼できる接続方法と考えられます。たとえば、接続先のプロキシが別のチームによって開発、維持されている場合は、信頼できるエンドポイントパスを使用して接続できます。

以下の例では、/v1/streetcarts/foodcarts/data-manager のターゲットプロキシを指定しています。ここで、ホストは現在のプロキシと同じであるものとします。詳細については、API プロキシ構成リファレンスをご覧ください。

<TargetEndpoint name="datamanager">
    <PreFlow name="PreFlow">
        <!-- PreFlow policies -->
    </PreFlow>
    <PostFlow name="PostFlow">
        <!-- PostFlow policies -->
    </PostFlow>
    <LocalTargetConnection>
        <Path>/v1/streetcarts/foodcarts/data-manager</Path>
    </LocalTargetConnection>
</TargetEndpoint>

<LocalTargetConnection> の <Path> 要素には文字列を指定できます。また、メッセージテンプレートを使用して動的に値を割り当てることもできます。

Apigee UI を使用したプロキシの接続

Apigee UI を使用して、プロキシ名またはパスによってプロキシを接続することもできます。以下の例では、ProxyA と ProxyB の 2 つのプロキシがあり、ProxyB を ProxyA のターゲットエンドポイントに指定します。プロキシ名でプロキシを接続するには、次の操作を行います。

Apigee UI にログインします。
左側のペインで [Develop] > [Proxies] を選択します。
プロキシのリストで ProxyA を選択します。
[Develop] タブをクリックします。

[Code] ペインで、XML の <TargetEndpoint> セクションを次のように置き換えます。

<TargetEndpoint>
  <LocalTargetConnection>
    <APIProxy>ProxyB</APIProxy>
    <ProxyEndpoint>default</ProxyEndpoint>
  </LocalTargetConnection>
</TargetEndpoint>

[Save] をクリックします。

チェーンで接続されたプロキシ、API プロダクト、セキュリティ

プロキシチェーンは、両方のプロキシが同じ API プロダクトに存在する場合に最適です。デフォルトでは、クライアントは両方を使用できます。Apigee では、クライアントがアクセスできない個別の API プロダクトに 2 番目のプロキシをバンドルすることはできません。

2 番目のプロキシを直接クライアントリクエストから保護する必要がある場合は、2 番目のプロキシにクライアントの IP アドレスを検証させるロジックを追加することを検討してください。チェーン接続で行われる呼び出しの場合、IP アドレスはローカルアドレスになります。処理を続行する前に、ローカルアドレスであることをコードで検証できます。方法については、AccessControl ポリシーをご覧ください。