431 Request Header Fields Too Large - TooBigHeaders

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

問題

用戶端應用程式會取得 431 Request Header Fields Too Large 的 HTTP 狀態碼，以及錯誤代碼 protocol.http.TooBigHeaders 做為 API 呼叫的回應。

錯誤訊息

用戶端應用程式會取得以下回應代碼：

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 的所有要求標頭總大小，超過 Apigee Edge 中允許的限制 (根據 RFC 6585 第 5 節：431 要求標頭欄位過大)，就會發生這個錯誤。

這項錯誤的可能原因如下：

原因	說明	適用的疑難排解指示
要求標頭大小超出允許的上限	用戶端應用程式向 Apigee Edge 發出的 HTTP 要求，傳送至所有標頭的總大小超過 Apigee Edge 中的允許限制。	Edge Public and Private Cloud 使用者

常見診斷步驟

請使用下列其中一種工具/技巧診斷這項錯誤：

原因：要求標頭大小超過允許的上限

診斷

1. 透過 API 監控或 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 的要求行大小。

   訊息處理器記錄

   如何使用訊息處理器記錄進行驗證：

   如果您是 Private Cloud 使用者，可使用訊息處理器記錄檔來驗證要求標頭大小是否超過 Apigee Edge 中的允許限制。

   1. 查看訊息處理器記錄：

      /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 邊緣限制中要求/回應標頭大小限制的要求/回應標頭。

1. 如果您是公開雲端使用者，要求和回應標頭大小的上限與 Apigee 邊緣限制中的「要求/回應標頭大小」相同。
2. 如果您是私有雲使用者 ，您可能已修改要求和回應標頭大小的預設上限 (即便不建議做法)。如要決定要求標頭大小上限，請按照如何查看目前限制中的指示操作。

如何查看目前的限制？

本節說明如何確認訊息處理器中的 HTTPRequest.headers.limit 屬性已更新為新值。

1. 在訊息處理器機器中，在 /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 中設定的要求標頭大小限制為 25 KB。

規格

Apigee Edge 預期用戶端應用程式不會在要求中傳送大型的標頭。如果要求中的標頭總大小超過指定限制，Apigee 會根據以下 RFC 規格擲回 431 Request Header Fields Too Large ：

規格
RFC 6585，第 5 節：431 要求標頭欄位過大

如果您仍需獲得 Apigee 支援團隊的協助，請參閱「必須收集診斷資訊」一文。

必須收集診斷資訊

收集下列診斷資訊，然後與 Apigee Edge 支援團隊聯絡：

如果您是公開雲端使用者，請提供下列資訊：

• 機構組織名稱
• 環境名稱
• API Proxy 名稱
• 完成用來重現 431 錯誤的 curl 指令
• API 要求的追蹤檔

如果您是 Private Cloud 使用者，請提供下列資訊：

• 觀察失敗要求的完整錯誤訊息
• 機構組織名稱
• 環境名稱
• API Proxy 套裝組合
• 失敗 API 要求的追蹤檔
• 完成用來重現 431 錯誤的 curl 指令

• NGINX 存取記錄檔 /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  其中：系統會將 ORG、ENV 和 PORT# 替換為實際值。

• 訊息處理器系統記錄 /opt/apigee/var/log/edge-message-processor/logs/system.log