431 リクエスト ヘッダー フィールドが大きすぎる - TooBigHeaders

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

症状

クライアント アプリケーションが、API 呼び出しに対するレスポンスとして、エラーコード protocol.http.TooBigHeaders 付きの HTTP ステータス コード 431 Request Header Fields Too Large を受け取ります。

エラー メッセージ

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

HTTP/1.1 431 Request Header Fields Too Large

さらに、次のエラー メッセージも確認できます。

{
   "fault":{
      "faultstring":"request headers size exceeding 25,600",
      "detail":{
         "errorcode":"protocol.http.TooBigHeaders"
      }
   }
}

考えられる原因

このエラーは、HTTP リクエストの一部としてクライアント アプリケーションから Apigee Edge に送信されたすべてのリクエスト ヘッダーの合計サイズが、 RFC 6585 のセクション 5: 431 Request Header Fields Too Large に準拠した Apigee Edge で許可されている上限を超えている場合に発生します。

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

共通の診断手順

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

原因: リクエスト ヘッダーのサイズが許容上限を超えている

診断

1. 一般的な診断手順で説明したように、API Monitoring または NGINX アクセスログを使用して、観測されたエラーの Fault Code、Fault Source、Request-Length size を特定します。
2. Fault Source の値が apigee または MP、Fault Code の値が protocol.http.TooBigHeaders、Request Length が 25 KB を超えている場合、これは、クライアント アプリケーションから Apigee に送信されたリクエスト サイズが Apigee Edge で許可されている上限を超えていることを示します。
3. リクエスト ヘッダーのサイズが許容上限の 25 KB を超えたことを確認するには、次のいずれかの方法を使用します。

   エラー メッセージ

   エラー メッセージを使用して検証するには:

   Apigee Edge から受信した完全なエラー メッセージにアクセスできる場合は、faultstring を参照してください。faultstring は、リクエスト ヘッダーの合計サイズが 25 KB の上限を超えていることを示します。

   エラー メッセージの例:

   "faultstring":"request headers size exceeding 25,600"

   実際のリクエスト

   実際のリクエストを使用して検証するには:

   クライアント アプリケーションによって行われた実際のリクエストにアクセスできる場合は、次の手順を行います。

   1. リクエストで渡されたヘッダーのサイズを確認します。

   2. ヘッダーの合計サイズが Apigee Edge で許可されている上限を超えている場合は、それが問題の原因です。

      リクエストの例:

      curl -v https://HOSTALIAS/test -H "header0: 000000000000000000……..000000<trimmed>" -H "header1: 111111111111111111……..111111<trimmed>" -H "header2: 222222222222222222……..222222<trimmed>"-H "header3: 333333333333333333……..333333<trimmed>"
      

      上記の例では、ヘッダー header0、header1、header2、header3 の合計サイズが 25 KB を超えています。つまり、25 K を超える ASCII 文字（バイト）が含まれています。

      他のクライアントを使用している場合は、クライアント ログを確認して、Apigee Edge に送信されているリクエスト行のサイズを特定してください。

   Message Processor ログ

   Message Processor のログを使用して検証するには:

   Private Cloud ユーザーは、Message Processor ログを使用して、リクエスト ヘッダーのサイズが Apigee Edge で許可されている上限を超えていないかどうかを確認できます。

   1. Message Processor のログを確認します。

      /opt/apigee/var/log/edge-message-processor/logs/system.log

   2. 特定の期間に 431 エラーが発生したかどうか（問題が過去に発生した場合）、または 431 で失敗したリクエストがまだあるかどうかを検索します。次の検索文字列を使用できます。

      grep -ri "exceeding"
      

      grep -ri "RequestHeadersTooLarge"
      

   3. system.log から次のような行が見つかります。

      2021-07-27 08:30:28,419  NIOThread@1 ERROR ADAPTORS.HTTP.FLOW -
      AbstractRequestListener.onException() :
      Request:GET, uri:/test/, message Id:null,
      exception:com.apigee.errors.http.user.RequestHeadersTooLarge{
      code = protocol.http.TooBigHeaders, message = request headers size
      exceeding 25,600, associated contexts = []}, context:Context@9c5903
      input=ClientInputChannel(SSLClientChannel[Accepted:
      Remote:192.168.205.251:8443 Local:192.168.67.23:22188]@25130
      useCount=1 bytesRead=0 bytesWritten=15367 age=667062ms  lastIO=0ms
      isOpen=true)

      上記のエラー メッセージのテキスト message = request headers size exceeding 25,600 は、リクエスト ヘッダーの合計サイズが 25 KB を超えていることを示しています。そのため、Apigee Edge は例外 com.apigee.errors.http.user.RequestHeadersTooLarge をスローし、障害コード protocol.http.TooBigHeaders を含む 431 ステータス コードをクライアント アプリケーションに返します。

解決策

上限

Apigee は、クライアント アプリケーションとバックエンド サーバーが、Apigee Edge の上限でリクエスト/レスポンス ヘッダー サイズの上限として記載されている上限を超えるリクエスト/レスポンス ヘッダーを送信しないことを想定しています。

1. パブリック クラウド ユーザーの場合、リクエスト ヘッダーとレスポンス ヘッダーの最大サイズは、Apigee Edge の上限のリクエスト ヘッダーとレスポンス ヘッダーのサイズに記載されているとおりです。
2. Private Cloud ユーザーの場合、 リクエスト ヘッダーとレスポンス ヘッダーのサイズのデフォルトの最大制限を変更している可能性があります（推奨される方法ではありません）。最大リクエスト ヘッダー サイズの上限は、現在の上限を確認する方法の手順に沿って確認できます。

現在の制限を確認する方法

このセクションでは、Message Processor でプロパティ HTTPRequest.headers.limit が新しい値で更新されたことを確認する方法について説明します。

1. Message Processor マシンで、/opt/apigee/edge-message-processor/conf ディレクトリの HTTPRequest.headers.limit プロパティを検索し、次のように設定されている値を確認します。

   grep -ri "HTTPRequest.headers.limit" /opt/apigee/edge-message-processor/conf
   

2. 上記のコマンドの出力例は次のとおりです。

   /opt/apigee/edge-message-processor/conf/http.properties:HTTPRequest.headers.limit=25k

3. 上記の出力例では、HTTPRequest.headers.limit プロパティが http.properties の値 25k で設定されています。

   これは、Apigee for Private Cloud で構成されたリクエスト ヘッダーのサイズの上限が 25 KB であることを示します。

仕様

Apigee Edge は、クライアント アプリケーションがリクエストの一部としてサイズの大きいヘッダーを送信しないことを想定しています。リクエストに指定された上限を超えるサイズのヘッダーが含まれている場合、Apigee は次の RFC 仕様に従って 431 Request Header Fields Too Large をスローします。

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

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

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

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

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

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

• 失敗したリクエストで確認されたエラー メッセージの全文
• 組織名
• 環境名
• API プロキシ バンドル
• 失敗した API リクエストのトレース ファイル
• 431 エラーを再現するために使用される完全な curl コマンド

• 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