502 Gateway inválido - ResponseWithBody

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Sintoma

O aplicativo cliente recebe um código de status HTTP 502 Bad Gateway com o código de erro 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ê pode observar 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 ocorre se a resposta HTTP do servidor de back-end para o Apigee Edge for 204 No Content ou 205 Reset Content mas contiver o corpo da resposta 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 Reset Content, espera-se que nenhum conteúdo adicional seja 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 da resposta.

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

Confira 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 resposta 204 do servidor de back-end

Diagnóstico

1. Determine o código de falha e a origem da falha do erro observado usando o monitoramento de APIs, a ferramenta Trace ou os registros de acesso do NGINX, conforme explicado em Etapas comuns do diagnóstico.
2. Se o código de falha for protocol.http.ResponseWithBody e a origem da falha tiver o valor target, isso indica que o servidor de back-end respondeu com um código de status 204 No Content ou 205 Reset Content com o corpo da resposta e/ou um dos cabeçalhos mencionados em Causas possíveis.

3. Para validar se o servidor de back-end realmente enviou um corpo de payload de resposta e/ou um ou mais dos cabeçalhos mencionados em Causas possíveis, você pode seguir estas etapas:

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

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

   3. Analise a resposta recebida do servidor de back-end e verifique se ela contém um corpo de payload de resposta e/ou um ou mais dos cabeçalhos mencionados acima. Em caso afirmativo, essa é a causa do erro.

      Exemplo 1

      Exemplo 1: resposta do servidor de back-end 204 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 204 No Content código de status e Content-Encoding: gzip

      Exemplo 2

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

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

      Exemplo 3

      Exemplo 3: resposta do servidor de back-end 205 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 205 Reset Content código de status com o corpo da resposta This is a sample Response.

   4. Em todos os exemplos acima, o servidor de back-end enviou 204 No Content ou 205 Reset Content código de status com o corpo da resposta e/ou um dos cabeçalhos mencionados em Causas possíveis.
   5. Portanto, o Apigee Edge enviou 502 Bad Gateway código de status com 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 Reset Content, ao enviar a resposta 204 No Content ou 205 Reset Content para o Apigee Edge. Ou seja, o servidor de back-end NÃO DEVE enviar o seguinte como parte de uma 204 No Content ou 205 Reset Content resposta:

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 502 Bad Gateway código de status e o código de erro protocol.http.ResponseWithBody se o servidor de back-end enviar uma 204 No Content ou 205 Reset Content resposta, mas não seguir as seguintes especificações da RFC:

Pontos importantes a serem observados

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

Se você ainda precisar de ajuda do suporte da Apigee, acesse Coletar informações de diagnóstico.

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

Reúna as seguintes informações de diagnóstico 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 de API
• Comando curl completo usado para reproduzir o erro 502
• Arquivo de trace para as solicitações de API

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

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

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

  Em que: 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