502 Bad Gateway - ResponseWithBody

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Síntoma

La aplicación cliente obtiene un código de estado HTTP 502 Bad Gateway con el código de error protocol.http.ResponseWithBody como respuesta a las llamadas a la API.

Mensaje de error

La aplicación cliente obtiene el siguiente código de respuesta:

HTTP/1.1 502 Bad Gateway

Además, es posible que observes uno de los siguientes mensajes de error:

{
   "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"
      }
   }
}

Causas posibles

Este error se produce si la respuesta HTTP del servidor de backend a Apigee Edge es 204 No Content o 205 Reset Content, pero contiene el cuerpo de la respuesta o uno o más de los siguientes encabezados:

• Content-Length
• Content-Encoding
• Transfer-Encoding

Según las especificaciones RFC 7231, sección 6.3.5: 204 No Content y RFC 7231, sección 6.3.6: 205 Reset Content, se espera que el servidor de origen no envíe contenido adicional como parte del cuerpo de la carga útil de la respuesta con el código de estado 204 No Content o 205 Reset Content. Los encabezados de respuesta como Content-Length, Content-Encoding o Transfer-Encoding indican el tamaño, el tipo o el formato de la carga útil de la respuesta.

Por lo tanto, Apigee Edge muestra un código de estado 502 Bad Gateway con el código de error protocol.http.ResponseWithBody al cliente en las siguientes circunstancias:

Estas son las posibles causas de este error:

Pasos comunes de diagnóstico

Usa una de las siguientes herramientas o técnicas para diagnosticar este error:

Causa: Cuerpo de la respuesta o encabezados con respuesta 204 del servidor de backend

Diagnóstico

1. Determina el Código de falla y la Fuente de falla del error observado con la Supervisión de API la herramienta Trace o los registros de acceso de NGINX, como se explica en Pasos comunes de diagnóstico.
2. Si el Código de falla es protocol.http.ResponseWithBody y Fuente de falla tiene el valor target, esto indica que el servidor de backend respondió con un código de estado 204 No Content o 205 Reset Content con el cuerpo de la respuesta o uno de los encabezados mencionados en Causas posibles.

3. Para validar si el servidor de backend envió un cuerpo de carga útil de respuesta o uno o más de los encabezados mencionados en Causas posibles, puedes seguir estos pasos:

   1. Si eres usuario de la nube pública y puedes realizar la misma solicitud a la API al servidor de backend directamente desde cualquiera de tus sistemas.

   2. Si eres usuario de la nube privada, puedes realizar la misma solicitud a la API al servidor de backend directamente desde uno de los Message Processors asociados con la organización y el entorno específicos en los que se observa la falla.

   3. Revisa la respuesta recibida del servidor de backend y verifica que contenga un cuerpo de carga útil de respuesta o uno o más de los encabezados mencionados anteriormente. Si es así, esa es la causa de este error.

      Ejemplo 1

      Ejemplo 1: Respuesta 204 del servidor de backend con encabezado Content-Encoding

      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
      

      En este ejemplo, el servidor de backend respondió con 204 No Content código de estado y Content-Encoding: gzip

      Ejemplo 2

      Ejemplo 2: Respuesta 204 del servidor de backend con encabezado Content-Length

      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
      

      En este ejemplo, el servidor de backend respondió con 204 No Content código de estado y Content-Length: 48

      Ejemplo 3

      Ejemplo 3: Respuesta 205 del servidor de backend con cuerpo de respuesta

      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
      

      En este ejemplo, el servidor de backend respondió con 205 Reset Content código de estado con el cuerpo de respuesta This is a sample Response.

   4. En todos los ejemplos anteriores, el servidor de backend envió 204 No Content o 205 Reset Content código de estado con el cuerpo de la respuesta o uno de los encabezados mencionados en Causas posibles.
   5. Por lo tanto, Apigee Edge envió 502 Bad Gateway código de estado con código de error protocol.http.ResponseWithBody.

Solución

Asegúrate de que el servidor de backend siempre cumpla con la especificación RFC 7231, sección 6.3.6: 205 Reset Content, cuando envíe la 204 No Content o 205 Reset Content respuesta a Apigee Edge. Es decir, el servidor de backend NO DEBE enviar lo siguiente como parte de una respuesta 204 No Content o 205 Reset Content:

1. Cuerpo de la carga útil de la respuesta
2. Y cualquiera de los siguientes encabezados:
   1. Content-Length
   2. Content-Encoding
   3. Transfer-Encoding

Especificación

Apigee Edge responde con el código de estado 502 Bad Gateway y el código de error protocol.http.ResponseWithBody si el servidor de backend envía una 204 No Content o 205 Reset Content respuesta, pero no cumple con las siguientes especificaciones de RFC:

Aspectos clave que debes tener en cuenta

La solución recomendada es corregir el servidor de backend para que envíe el 204 No Content y 205 Reset Content código de estado sin el cuerpo de la respuesta ni ninguno de los encabezados (`Content-Length`, `Content-Encoding` y `Transfer-Encoding`) y cumpla con las especificaciones RFC 7231, sección 6.3.5: 204 No Content y RFC 7231, sección 6.3.6: 205 Reset Content.

Si aún necesitas ayuda de Asistencia de Apigee, consulta Se debe recopilar información de diagnóstico.

Se debe recopilar información de diagnóstico

Recopila la siguiente información de diagnóstico y, luego, comunícate con Asistencia de Apigee Edge:

Si eres usuario de la nube pública, proporciona la siguiente información:

• Nombre de la organización
• Nombre del entorno
• Nombre del proxy de API
• Comando curl completo que se usó para reproducir el error 502
• Archivo de seguimiento de las solicitudes a la API

Si eres usuario de la nube privada, proporciona la siguiente información:

• Mensaje de error completo observado para las solicitudes con errores
• Nombre del entorno
• Paquete de proxy de API
• Archivo de seguimiento de las solicitudes a la API

• Registros de acceso de NGINX /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  Donde: ORG, ENV y PORT# se reemplazan por valores reales.

• Registros del sistema de Message Processor /opt/apigee/var/log/edge-message-processor/logs/system.log