ストリーミングのリクエストとレスポンス

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

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

このトピックで説明する内容

このトピックを読むと、次の内容を理解できます。

Apigee でのリクエストとレスポンスのストリーミング
リクエストとレスポンスのストリーミングを使用すべき状況
リクエストとレスポンスのストリーミングを有効にする方法

リクエストとレスポンスのストリーミングとは

デフォルトでは HTTP ストリーミングは無効です。HTTP リクエストおよびレスポンスのペイロードは、メモリ内のバッファに書き込まれてから、API プロキシパイプラインによって処理されます。この動作は、ストリーミングを有効にすることで変更できます。ストリーミングを有効にすると、リクエストとレスポンスのペイロードは変更されずに、クライアントアプリ（レスポンスの場合）やターゲットエンドポイント（リクエストの場合）にストリーミングされます。

ストリーミングを有効にすべき状況

API プロキシが非常に大きなリクエストやレスポンス（サイズ上限については、ストリーミングについて他に知っておくべきことを参照）を処理する場合は、ストリーミングを有効にするとよいでしょう。

注: API が大量のデータをリクエストまたは返す場合、次の HTTP エラーが表示されることがあります。

{"fault":"{\"detail\":{\"errorcode\":\"protocol.http.TooBigBody\"},\"faultstring\":\"Body buffer overflow\"}"}

このエラーが表示された場合は、ストリーミングを有効にすることをおすすめします。ストリーミングを有効にした後も引き続きエラーが表示される場合は、リクエストペイロードまたはレスポンスペイロードにアクセスする必要のあるポリシーをすべて削除することを検討してください。詳細については、メッセージペイロードのサイズをご覧ください。

ストリーミングについて他に知っておくべきこと

メッセージペイロードのサイズは、10 MB に制限されています。ストリーミングされていないリクエストとレスポンスでは、そのサイズを超えると protocol.http.TooBigBody エラーが発生します。

エンコードされたデータ

ストリーミングが有効になっている場合、Apigee は、Apigee またはバックエンドターゲットサーバーに接続するクライアントに送信する前に、リクエストまたはレスポンスのペイロードをエンコードまたはデコードしません。詳細については、TargetEndpoint トランスポートプロパティの仕様の表にある request.streaming.enabled と response.streaming.enabled の行をご覧ください。

リクエストとレスポンスのストリーミングを有効にする方法

リクエストのストリーミングを有効にするには、プロキシバンドルの ProxyEndpoint 定義と TargetEndpoint 定義に request.streaming.enabled プロパティを追加し、true に設定する必要があります。同様に、response.streaming.enabled プロパティを設定して、レスポンスのストリーミングを有効にします。

これらの構成ファイルの場所は、プロキシの Apigee UI の [Develop] ビューで確認できます。ローカルで開発している場合、定義ファイルは apiproxy/proxies と apiproxy/targets にあります。

このサンプルは、TargetEndpoint 定義でリクエストとレスポンス両方のストリーミングを有効にする方法を示しています。

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
    <Properties>
      <Property name="response.streaming.enabled">true</Property>
      <Property name="request.streaming.enabled">true</Property>
      <Property name="supports.http10">true</Property>
      <Property name="request.retain.headers">User-Agent,Referer,Accept-Language</Property>
      <Property name="retain.queryparams">apikey</Property>
    </Properties>
  </HTTPTargetConnection>
</TargetEndpoint>

次の例では、ProxyEndpoint 定義でレスポンスとリクエストのストリーミングを有効にする方法を示しています。

<ProxyEndpoint name="default">
  <HTTPProxyConnection>
    <BasePath>/v1/weather</BasePath>
    <Properties>
      <Property name="allow.http10">true</Property>
      <Property name="response.streaming.enabled">true</Property>
      <Property name="request.streaming.enabled">true</Property>
    </Properties>
  </HTTPProxyConnection>
</ProxyEndpoint>

エンドポイント定義の構成の詳細については、エンドポイントプロパティのリファレンスをご覧ください。