502 Gateway inválido - ResponseWithBody

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Sintoma

O aplicativo cliente recebe um código de status HTTP 502 Bad Gateway com o erro código protocol.http.ResponseWithBody como resposta para chamadas de API.

Mensagem de erro

O aplicativo cliente recebe o seguinte código de resposta:

HTTP/1.1 502 Bad Gateway

Além disso, você poderá encontrar uma das seguintes mensagens de erro:

{
   "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 possíveis

Esse erro ocorrerá se a resposta HTTP do servidor de back-end para o Apigee Edge for 204 No Content ou 205 Reset Content, mas contém a resposta body e/ou um ou mais dos seguintes cabeçalhos:

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

De acordo com as especificações RFC 7231, seção 6.3.5: 204 No Content e RFC 7231, seção 6.3.6: 205 Redefinir conteúdo, espera-se que nenhum conteúdo adicional precisa ser enviado como parte do corpo do payload da resposta com o código de status 204 No Content ou 205 Reset Content pelo servidor de origem. Os cabeçalhos de resposta como Content-Length, Content-Encoding ou Transfer-Encoding indicam o tamanho, o tipo ou o formato do payload de resposta.

Portanto, o Apigee Edge retorna um código de status 502 Bad Gateway com o código de erro protocol.http.ResponseWithBody para o cliente no seguinte circunstâncias:

Estas são as possíveis causas desse erro:

Etapas comuns do diagnóstico

Use uma das seguintes ferramentas/técnicas para diagnosticar esse erro:

Causa: corpo da resposta ou cabeçalhos com a resposta 204 do servidor de back-end

Diagnóstico

1. Determine o código da falha e a fonte da falha do erro observado usando a API do Monitoring, da ferramenta Trace ou de acesso do NGINX, conforme explicado em Etapas comuns de diagnóstico.
2. Se o Código da falha for protocol.http.ResponseWithBody e A Origem da falha tem o valor target, o que indica que o back-end servidor respondeu com um status 204 No Content ou 205 Reset Content com o corpo da resposta e/ou um dos cabeçalhos mencionados Possíveis causas.

3. Para validar se o servidor de back-end realmente enviou um corpo de carga útil de resposta e/ou um ou mais cabeçalhos mencionados em Possíveis causas, siga estas etapas:

   1. Se você for um usuário de nuvem pública e puder fazer a mesma solicitação de API para o servidor de back-end diretamente de qualquer um dos seus sistemas.

   2. Se você é um usuário da nuvem privada, pode fazer a mesma solicitação de API para o servidor de back-end diretamente de um dos processadores de mensagens associados à da organização e do ambiente em que a falha é observada.

   3. Revise a resposta recebida do servidor de back-end e verifique se ela contém um corpo da carga da resposta e/ou um ou mais dos cabeçalhos mencionados acima. Se sim, isso é a causa desse erro.

      Amostra 1

      Exemplo 1: resposta 204 do servidor de back-end com cabeçalho 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
      

      Neste exemplo, o servidor de back-end respondeu com Código de status 204 No Content e Content-Encoding: gzip

      Amostra 2

      Exemplo 2: Resposta 204 do servidor de back-end com cabeçalho de tamanho de conteúdo

      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
      

      Neste exemplo, o servidor de back-end respondeu com Código de status 204 No Content e Content-Length: 48

      Amostra 3

      Exemplo 3: Resposta 205 do servidor de back-end com corpo de resposta

      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
      

      Neste exemplo, o servidor de back-end respondeu com Código de status 205 Reset Content com corpo da resposta This is a sample Response.

   4. Em todos os exemplos acima, o servidor de back-end enviou 204 No Content ou Código de status 205 Reset Content com o corpo da resposta e/ou um dos cabeçalhos mencionados em Possíveis causas.
   5. Portanto, a Apigee Edge enviou o código de status 502 Bad Gateway com o código de erro protocol.http.ResponseWithBody.

Resolução

Verifique se o servidor de back-end sempre segue a especificação RFC 7231, seção 6.3.6: 205 Redefinir conteúdo, ao enviar o 204 No Content ou 205 Reset Content para a Apigee Edge. Ou seja, o servidor de back-end NÃO É POSSÍVEL enviar o seguinte como parte de um 204 No Content ou Resposta do 205 Reset Content:

1. Corpo do payload da resposta
2. E qualquer um dos seguintes cabeçalhos:
   1. Content-Length
   2. Content-Encoding
   3. Transfer-Encoding

Especificação

O Apigee Edge responde com o código de status 502 Bad Gateway e o código de erro protocol.http.ResponseWithBody se o servidor de back-end enviar um 204 No Content ou 205 Reset Content, mas não está em conformidade com as seguintes especificações de RFC:

Pontos principais a observar

A solução recomendada é corrigir o servidor de back-end para enviar o 204 No Content e o código de status 205 Reset Content sem corpo de resposta e qualquer um dos cabeçalhos Content-Length, Content-Encoding e Transfer-Encoding e atendem às especificações RFC 7231, seção 6.3.5: 204 No Content e RFC 7231, seção 6.3.6: 205 Redefinir conteúdo.

Se você ainda precisar de ajuda do suporte da Apigee, acesse É necessário coletar informações de diagnóstico.

É necessário coletar informações de diagnóstico

Colete as informações de diagnóstico a seguir e entre em contato com o suporte do Apigee Edge:

Se você for um usuário da nuvem pública, forneça as seguintes informações:

• Nome da organização
• Nome do ambiente
• Nome do proxy da API
• Comando curl completo usado para reproduzir o erro 502
• Arquivo de rastreamento para as solicitações de API

Se você for um usuário da nuvem privada, forneça estas informações:

• Mensagem de erro completa observada para as solicitações com falha
• Nome do ambiente
• Pacote de proxy de API
• Arquivo de rastreamento para as solicitações de API

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

  Onde:ORG, ENV e PORT# são substituídos por valores reais.

• Registros do sistema do processador de mensagens /opt/apigee/var/log/edge-message-processor/logs/system.log