502 网关无效 - ResponseWithBody

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

问题

客户端应用收到 HTTP 状态代码 502 Bad Gateway（错误代码为 protocol.http.ResponseWithBody），作为 API 调用的响应。

错误消息

客户端应用会获得以下响应代码：

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 无内容和 RFC 7231 第 6.3.6 节：205 重置内容规范，源服务器不应在响应载荷正文（包含状态代码 204 No Content 或 205 Reset Content）中发送任何其他内容。Content-Length、Content-Encoding 或 Transfer-Encoding 等响应标头指示响应载荷的大小、类型或格式。

因此，在以下情况下，Apigee Edge 会向客户端返回 502 Bad Gateway 状态代码以及错误代码 protocol.http.ResponseWithBody：

	来自后端服务器的状态代码
来自后端服务器的响应包含	204 No Content	205 重置内容
响应正文	错误	错误
Content-Length 标头 （设置为非零值）	错误	错误
Content-Encoding （设置为 Apigee Edge 中支持的编码）	错误	无错误
Transfer-Encoding	错误	错误

以下是导致此错误的可能原因：

原因	说明	适用的问题排查说明
从后端服务器返回 204 响应的响应正文或标头	后端服务器发送包含响应正文和/或一个或多个标头 Content-Type、Content-Encoding 或 Transfer-Encoding 的 204 No Content 或 205 Reset Content 响应。	Edge 公有云和私有云用户

常见诊断步骤

使用以下工具/技巧之一来诊断此错误：

原因：响应正文或来自后端服务器返回 204 响应的标头

诊断

1. 按照常见诊断步骤中所述，使用 API 监控、Trace 工具或 NGINX 访问日志确定观察到的错误的故障代码和故障来源。
2. 如果 Fault Code 为 protocol.http.ResponseWithBody，并且 Fault Source 的值为 target，这表示后端服务器已使用 204 No Content 或 205 Reset Content 状态代码进行响应，并显示响应正文和/或可能的原因中提到的其中一个标头。

3. 如需验证后端服务器是否确实发送了响应载荷正文和/或可能的原因中提到的一个或多个标头，您可以执行以下步骤：

   1. 如果您是公有云用户，并且可以直接从您的任何系统向后端服务器发出相同的 API 请求。

   2. 如果您是私有云用户，则可以直接从与观察到失败的特定组织和环境关联的某个消息处理器向后端服务器发出相同的 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
      

      在此示例中，后端服务器返回 205 Reset Content 状态代码，响应正文为 This is a sample Response.

   4. 在上述所有示例中，后端服务器随响应正文和/或可能的原因中提到的其中一个标头发送了 204 No Content 或 205 Reset Content 状态代码。
   5. 因此，Apigee Edge 发送了 502 Bad Gateway 状态代码，错误代码为 protocol.http.ResponseWithBody。

分辨率

在向 Apigee Edge 发送 204 No Content 或 205 Reset Content 响应时，确保后端服务器始终遵循规范 RFC 7231 第 6.3.6 节：205 重置内容。也就是说，后端服务器不得将以下内容作为 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：

规范
RFC 7231，第 6.3.5 节：204 无内容
RFC 7231，第 6.3.6 节：205 重置内容

需要注意的要点

建议的解决方案是修复后端服务器，以发送不含响应正文和任何标头（Content-Length、Content-Encoding 和 Transfer-Encoding）的 204 No Content 和 205 Reset Content 状态代码，并遵循 RFC 7231 第 6.3.5 节：204 无内容和 RFC 7231 第 6.3.6 节：205 重置内容规范。

如果您仍然需要 Apigee 支持的任何帮助，请参阅必须收集诊断信息。

必须收集的诊断信息

收集以下诊断信息，然后联系 Apigee Edge 支持团队：

如果您是公有云用户，请提供以下信息：

• 组织名称
• 环境名称
• API 代理名称
• 完成用于重现 502 错误的 curl 命令
• API 请求的跟踪文件

如果您是 Private Cloud 用户，请提供以下信息：

• 观察到失败请求的完整错误消息
• 环境名称
• API 代理软件包
• API 请求的跟踪文件

• 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