502 Bad Gateway - ResponseWithBody

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動します。 情報

症状

クライアント アプリケーションが、API 呼び出しに対するレスポンスとして、エラーコード protocol.http.ResponseWithBody を含む HTTP ステータス コード 502 Bad Gateway を受け取ります。

エラー メッセージ

クライアント アプリケーションは、次のレスポンス コードを受け取ります。

HTTP/1.1 502 Bad Gateway

また、次のいずれかのエラー メッセージが表示されることがあります。

{
   "fault":{
      "faultstring":"Received 204 Response with message body",
      "detail":{
         "errorcode":"protocol.http.ResponseWithBody"
      }
   }
}

{
   "fault":{
      "faultstring":"Received 205 Response with message body",
      "detail":{
         "errorcode":"protocol.http.ResponseWithBody"
      }
   }
}

考えられる原因

このエラーは、バックエンド サーバーから Apigee Edge への HTTP レスポンスが 204 No Content または 205 Reset Content であるのに、レスポンスの本文や次のヘッダーが含まれている場合に発生します。

• Content-Length
• Content-Encoding
• Transfer-Encoding

仕様 RFC 7231、セクション 6.3.5: 204 No Content と RFC 7231、セクション 6.3.6: 205 Reset Content に従って、配信元サーバーはステータス コード 204 No Content または 205 Reset Content を含むレスポンス ペイロード本文の一部として追加のコンテンツを送信しないことが想定されます。Content-Length、Content-Encoding、Transfer-Encoding などのレスポンス ヘッダーは、レスポンス ペイロードのサイズ、タイプ、形式を示します。

そのため、Apigee Edge は次の状況で、エラーコード protocol.http.ResponseWithBody を含むステータス コード 502 Bad Gateway をクライアントに返します。

このエラーの原因として、次のことが考えられます。

共通の診断手順

次のいずれかのツールまたは手法を使用して、このエラーを診断します。

原因: バックエンド サーバーからの 204 レスポンスのレスポンス本文またはヘッダー

診断

1. 一般的な診断手順で説明されているように、API Monitoring、Trace ツール、NGINX アクセスログを使用して、観測されたエラーの障害コードと障害ソースを特定します。
2. 障害コードが protocol.http.ResponseWithBody で、障害ソースの値が target の場合、バックエンド サーバーが 204 No Content ステータス コードまたは 205 Reset Content ステータス コードと、レスポンス本文または考えられる原因で説明されているヘッダーのいずれかで応答したことを示します。

3. バックエンド サーバーが実際にレスポンス ペイロードの本文や、考えられる原因で説明したヘッダーを送信したかどうかを確認するには、次の手順を行います。

   1. Public Cloud ユーザーで、システムからバックエンド サーバーに同じ API リクエストを直接送信できる場合。

   2. Private Cloud ユーザーは、障害が発生した特定の組織と環境に関連付けられている Message Processor のいずれかから、バックエンド サーバーに同じ API リクエストを直接送信できます。

   3. バックエンド サーバーから受信したレスポンスを確認し、レスポンス ペイロードの本文や上記のヘッダーが含まれていることを確認します。呼び出している場合は、それがエラーの原因です。

      サンプル 1

      サンプル 1: Content-Encoding ヘッダーを含むバックエンド サーバー レスポンス 204

      curl -v "https://BACKEND_SERVER_HOST_NAME/PATH" -H "HEADER: VALUE" -X HTTP_REQUEST_METHOD
      

      …
      < HTTP/1.1 204 No Content
      < Content-Encoding: gzip
      < Date: Tue, 31 Jul 2021 21:41:13 GMT
      < Connection: keep-alive
      

      このサンプルでは、バックエンド サーバーがステータス コード 204 No Content と Content-Encoding: gzip で応答しています。

      サンプル 2

      サンプル #2: Content-Length ヘッダーを含むバックエンド サーバー レスポンス 204

      curl -v "https://BACKEND_SERVER_HOST_NAME/PATH" -H "HEADER: VALUE" -X HTTP_REQUEST_METHOD
      

      …
      < HTTP/1.1 204 No Content
      < Content-Length: 48
      < Date: Tue, 31 Jul 2021 21:41:13 GMT
      < Connection: keep-alive
      

      このサンプルでは、バックエンド サーバーがステータス コード 204 No Content と Content-Length: 48 で応答しています。

      サンプル #3

      サンプル 3: レスポンス本文を含むバックエンド サーバー レスポンス 205

      curl -v "https://BACKEND_SERVER_HOST_NAME/PATH" -H "HEADER: VALUE" -X HTTP_REQUEST_METHOD
      

      …
      < HTTP/1.1 205 Reset Content
      < Date: Sat, 31 Jul 2021 17:14:09 GMT
      < Content-Length: 12
      < Content-Type: text/plain; charset=utf-8
      <
      * Connection #0 to host X.X.X.X left intact
      This is a sample Response
      

      この例では、バックエンド サーバーがレスポンス本文 This is a sample Response. でステータス コード 205 Reset Content を返しました。

   4. 上記のすべての例で、バックエンド サーバーはレスポンス ボディと、考えられる原因で説明したヘッダーのいずれかとともに、204 No Content または 205 Reset Content ステータス コードを送信しました。
   5. そのため、Apigee Edge はエラーコード protocol.http.ResponseWithBody で 502 Bad Gateway ステータス コードを送信しました。

解決策

バックエンド サーバーが 204 No Content または 205 Reset Content レスポンスを Apigee Edge に送信する際に、常に RFC 7231 のセクション 6.3.6: 205 Reset Content の仕様に準拠していることを確認します。つまり、バックエンド サーバーは、204 No Content または 205 Reset Content レスポンスの一部として以下を送信してはなりません。

1. レスポンス ペイロードの本文
2. また、次のいずれかのヘッダー。
   1. Content-Length
   2. Content-Encoding
   3. Transfer-Encoding

仕様

バックエンド サーバーが 204 No Content または 205 Reset Content レスポンスを送信しても、次の RFC 仕様に準拠していない場合、Apigee Edge はステータス コード 502 Bad Gateway とエラーコード protocol.http.ResponseWithBody で応答します。

重要なポイント

推奨される解決策は、バックエンド サーバーを修正して、レスポンス本文とヘッダー（Content-Length、Content-Encoding、Transfer-Encoding）なしで 204 No Content と 205 Reset Content のステータス コードを送信し、 RFC 7231、セクション 6.3.5: 204 No Content と RFC 7231、セクション 6.3.6: 205 Reset Content の仕様に準拠することです。

Apigee サポートのサポートが必要な場合は、診断情報の収集が必要な場合をご覧ください。

診断情報の収集が必要な場合

次の診断情報を収集して、Apigee Edge サポートにお問い合わせください。

Public Cloud ユーザーの場合は、次の情報を提供してください。

• 組織名
• 環境名
• API プロキシ名
• 502 エラーを再現するために使用される完全な curl コマンド
• API リクエストのトレース ファイル

Private Cloud ユーザーの場合は、次の情報を提供してください。

• 失敗したリクエストで確認されたエラー メッセージの全文
• 環境名
• API プロキシ バンドル
• API リクエストのトレース ファイル

• NGINX アクセスログ /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  説明: ORG、ENV、PORT# は実際の値に置き換えます。

• Message Processor のシステムログ /opt/apigee/var/log/edge-message-processor/logs/system.log