414 Request-URI Too Long - TooBigLine

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

問題

用戶端應用程式會收到 HTTP 狀態碼 414 Request-URI Too Long，以及錯誤代碼 protocol.http.TooBigLine ，做為 API 呼叫的回應。

錯誤訊息

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

HTTP/1.1 414 Request-URI Too Long

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

{
   "fault":{
      "faultstring":"request line size exceeding 7,168",
      "detail":{
         "errorcode":"protocol.http.TooBigLine"
      }
   }
}

請注意，上述錯誤訊息中的 faultstring 包含 Apigee Edge 中要求行的允許上限，即 7168 bytes (7 KB)。

可能原因

如果用戶端應用程式傳送至 Apigee Edge 的要求行大小，超過 Apigee Edge 允許的上限，就會發生這個錯誤。

在探討這項錯誤的可能原因之前，我們先瞭解要求行代表的意義，以及如何檢查要求行的大小。

瞭解 Request-Line

典型的 HTTP 要求包含三個部分：

1. Request-Line
2. ( Set of HTTP headers )
3. [ Body ]

要求行包含三個部分，如下所示。

Request-Line = <Method> <Request-URI> <HTTP-Version>

當用戶端應用程式向伺服器發出 HTTP 要求時，傳送至伺服器的第一行會包含上述要求行。接著是標頭和要求主體/酬載。

以下螢幕截圖範例顯示典型的 curl 要求、「Request」(要求) 部分 (連同要求行) 和「Response」(回應) 部分。

瞭解 Request-Line 大小

1. 在上述範例中，要求中的 start 行 (第一行) 也稱為「Request-Line」，如下所示：

   GET /test/ HTTP/1.1

   Request-Line 的大小為 ~19 bytes，因為其中包含 19 ASCII characters。由於這是在 Apigee Edge 允許的限制內，因此要求會順利處理，且您會收到成功回應。

2. 同樣地，如果您查看上方顯示的 錯誤訊息中的 faultstring，會發現其中包含 "request line size exceeding 7,168"。這表示用戶端發出的 HTTP 要求中的 Request-Line 超過 7,168 位元組。

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

常見的診斷步驟

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

原因：要求酬載大小超過允許的上限

診斷

1. 使用 API 監控、追蹤工具或 NGINX 存取記錄，判斷觀察到的錯誤的「錯誤代碼」、「錯誤來源」和「要求長度大小」，如「常見診斷步驟」一文所述。
2. 如果「Fault Source」的值為 apigee 或 MP，表示用戶端應用程式傳送至 Apigee 的要求大小超過 Apigee Edge 允許的上限。
3. 如要驗證要求行大小是否超過 7 KB 的允許上限，請使用下列其中一種方法：

   錯誤訊息

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

   如果您可以存取 Apigee Edge 傳送的完整錯誤訊息，請參閱 faultstring。faultstring 表示 Request-Line 大小超過允許的 7 KB 上限。

   錯誤訊息範例：

   "faultstring":"request line size exceeding 7,168"

   實際要求

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

   如果您可以存取用戶端應用程式發出的實際要求，請執行下列步驟：

   1. 確認要求中傳遞的 URI 大小。

   2. 如果發現 URI 大小超過 Apigee Edge 允許的限制，這就是問題的原因。

      要求範例：

      curl http://<hostalias>/testtoobigline?_qparam=000000000000000000……..000000<trimmed> -k -X POST
      

      在上述情況中，查詢參數 qparam 的值大於 7 KB，也就是包含超過 7,000 個 ASCII 字元。

      如果您使用其他用戶端，可以查看用戶端記錄，嘗試找出傳送至 Apigee Edge 的要求行大小。

   訊息處理器記錄

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

   如果您是私有雲使用者，可以透過訊息處理器記錄檔，驗證 Request-Line 大小是否超出 Apigee Edge 允許的限制。

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

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

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

      grep -ri "exceeding"
      

      grep -ri "RequestURITooLong"
      

   3. 您會找到類似下列的 system.log 行：

      2021-07-12 08:53:31,461  NIOThread@0 ERROR ADAPTORS.HTTP.FLOW -
      AbstractRequestListener.onException() : Request:null, uri:null,
      message Id:null, exception:com.apigee.errors.http.user.RequestURITooLong{
      code = protocol.http.TooBigLine, message = request line size exceeding 7,168,
      associated contexts = []}, context:Context@366f4217
      input=ClientInputChannel(SSLClientChannel[Accepted: Remote:192.168.195.90:8443
      Local:192.168.67.23:34256]@301912 useCount=1 bytesRead=0 bytesWritten=45849
      age=2254670ms lastIO=0ms isOpen=true)

      上述錯誤訊息中的文字 message = request line size exceeding 7,168 表示要求 URI 大小超過 7 KB。因此，Apigee Edge 會擲回例外狀況 com.apigee.errors.http.user.RequestURITooLong，並傳回 414 狀態碼和錯誤代碼 protocol.http.TooBigline 給用戶端應用程式。

解析度

限制

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

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

如何查看目前的限制？

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

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

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

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

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

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

   這表示在 Apigee for Private Cloud 中設定的要求行大小限制為 7 KB。

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

必須收集診斷資訊

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

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

• 機構名稱
• 環境名稱
• API Proxy 名稱
• 用於重現 414 錯誤的完整 curl 指令
• API 要求的追蹤記錄檔

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

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