502 閘道錯誤 - TooBigHeaders

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

問題

用戶端應用程式會收到 HTTP 狀態碼 502 Bad Gateway，以及錯誤代碼 protocol.http.TooBigHeaders ，做為 API 呼叫的回應。

錯誤訊息

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

HTTP/1.1 502 Bad Gateway

此外，您可能會看到下列錯誤訊息：

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

可能原因

如果目標/後端伺服器傳送至 Apigee Edge 的標頭總大小 (屬於 HTTP 回應的一部分) 大於 Apigee Edge 允許的上限，就會發生這個錯誤。

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

常見的診斷步驟

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

原因：回應中的標頭大小超過允許的上限

診斷

1. 使用 API 監控、追蹤工具或 NGINX 存取記錄，判斷觀察到的錯誤的錯誤代碼、錯誤來源和回應酬載大小，如常見診斷步驟所述。
2. 如果「Fault Source」(錯誤來源) 的值為 target，表示目標/後端伺服器傳送給 Apigee 的回應標頭大小，超過 Apigee Edge 允許的限制。
3. 如要驗證目標/後端的回應標頭大小是否超過允許的上限，請使用下列其中一種方法：

   錯誤訊息

   如何使用錯誤訊息進行驗證：

   如果您可以存取 Apigee Edge 傳送的完整錯誤訊息，請參閱 faultstring。faultstring 表示回應標頭大小超過允許的上限。

   錯誤訊息範例：

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

   在上述錯誤訊息中，請注意 faultstring，回應的標頭總大小超過允許的上限。

   實際要求

   如要使用實際要求進行驗證，請按照下列步驟操作：

   如果您可以存取傳送至目標/後端伺服器的實際要求，請執行下列步驟：

   1. 如果您是公有雲/私有雲使用者，請直接從後端伺服器本身，或您獲准向後端伺服器提出要求的任何其他機器，向後端伺服器提出要求。
   2. 如果您是私有雲使用者，也可以從其中一個訊息處理器向後端伺服器提出要求。
   3. 檢查從後端伺服器收到的回應，並特別計算及驗證回應中傳遞的標頭總大小。

   4. 如果發現回應酬載中的標頭大小超過 Apigee Edge 允許的上限，這就是問題的原因。

      目標伺服器的範例回應：

      curl -v https://TARGET_SERVER_HOST/test
      

      * About to connect() to 10.1.0.10 port 9000 (#0)
      *   Trying 10.1.0.10...
      * Connected to 10.1.0.10 (10.1.0.10) port 9000 (#0)
      > GET /test HTTP/1.1
      > User-Agent: curl/7.29.0
      > Host: 10.1.0.10:9000
      > Accept: */*
      <
      < HTTP/1.1 200 OK
      < Accept-Ranges: bytes
      < Content-Length: 0
      < Content-Type: text/plain; charset=utf-8
      < Last-Modified: Tue, 20 Jul 2021 09:23:56 GMT
      < Testheader1: XVlBzgba—-<snipped>---THctcuAx
      < Testheader2: hxKQFDaFpLSj—-<snipped>---FbcXoEFfRsWxP
      < Date: Fri, 23 Jul 2021 09:51:22 GMT
      <
      * Connection #0 to host 10.1.0.10 left intact
      

      在上述範例中，Testheader1 和 Testheader2 的大小較大，因此超過 Apigee Edge 允許的限制，導致發生這個錯誤。

   訊息處理器記錄

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

   如果您是 Private Cloud 使用者，可以透過訊息處理器記錄，驗證回應標頭大小是否超出 Apigee Edge 允許的限制。

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

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

   2. 搜尋特定時間範圍內是否有任何 502 錯誤 (如果問題發生在過去)，或是否有任何要求仍失敗並顯示 502。您可以使用下列搜尋字串：

      grep -ri "response headers size exceeding"
      

   3. 您會看到類似下列內容的 system.log 行。 在您的情況下，回應標頭大小可能有所不同：

      2021-07-23 08:25:12,307 org:myorg env:prod api:bigheadertest rev:1
      messageid:r23ijb1b-1  NIOThread@1 ERROR HTTP.CLIENT -
      HTTPClient$Context$3.onException() :  ClientChannel[Connected:
      Remote:3.7.1.1:9000 Local:192.168.2.1:56098]@8414 useCount=1
      bytesRead=0 bytesWritten=207 age=640ms  lastIO=0ms  isOpen=true.onExceptionRead
      exception: {}
      com.apigee.errors.http.server.BadGateway: response headers size exceeding 25,600
      
      2021-07-23 08:25:12,307 org:myorg env:prod api:bigheadertest
      rev:1 messageid:r23ijb1b-1  NIOThread@1 ERROR ADAPTORS.HTTP.FLOW -
      AbstractResponseListener.onException() : AbstractResponseListener.onError
      (HTTPResponse@31f3ef88, response headers size exceeding 25,600)

   4. 訊息處理器從後端/目標伺服器取得回應後，如果發現標頭總大小超過 25 KB，就會停止並擲回錯誤：

      response headers size exceeding 25,600

      這表示「Total Header Size」超過 25 KB，且 Apigee 在大小開始超過 25 KB 上限時，會擲回錯誤，錯誤代碼為 protocol.http.TooBigHeaders。

解析度

限制

Apigee 預期用戶端應用程式和後端伺服器不會傳送超過允許上限的標頭大小，如 Apigee Edge 限制中「要求/回應標頭大小」一節所述。

1. 如果您是公有雲使用者，要求和回應標頭大小上限與 Apigee Edge 限制中要求/回應標頭大小的規定相同。
2. 如果您是私有雲使用者 ，可能已修改要求和回應標頭大小的預設上限 (即使不建議這麼做)。如要判斷回應標頭大小上限，請按照「如何查看目前上限」一文中的操作說明進行。

如何查看目前的限制？

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

1. 在訊息處理器電腦上，搜尋 /opt/apigee/edge-message-processor/conf 目錄中的 HTTPResponse.headers.limit 屬性，然後檢查已設定的值，如下所示：

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

2. 上述指令的範例結果如下：

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

3. 在上述輸出範例中，請注意屬性 HTTPResponse.headers.limit 已在 http.properties 中設為 25k 值。

   這表示在 Apigee for Private Cloud 中設定的回應酬載大小上限為 25 KB。

如果仍需要 Apigee 支援團隊協助，請參閱「必須收集診斷資訊」。

必須收集診斷資訊

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

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

• 機構名稱
• 環境名稱
• API Proxy 名稱
• 用於重現 502 錯誤的完整 curl 指令
• API 要求的追蹤記錄檔
• 目標/後端伺服器回應的完整輸出內容，以及標頭大小

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

• 失敗要求顯示的完整錯誤訊息
• 機構名稱
• 環境名稱
• API Proxy 套裝組合
• 失敗 API 要求的追蹤記錄檔
• 用於重現 502 錯誤的完整 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