400 Solicitação inválida - DecompressionFailureAtRequest

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 400 Bad Request com o código de erro messaging.adaptors.http.flow.DecompressionFailureAtRequest como resposta às chamadas da API.

Mensagem de erro

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

HTTP/1.1 400 Bad Request

Além disso, você pode receber uma mensagem de erro semelhante a esta:

{
   "fault":{
      "faultstring":"Decompression failure at request",
      "detail":{
         "errorcode":"messaging.adaptors.http.flow.DecompressionFailureAtRequest"
      }
   }
}

Causas possíveis

Esse erro só ocorrerá se:

  • A codificação especificada no cabeçalho Content-Encoding da solicitação HTTP é válida e compatível com o Apigee Edge,
  • MAS

  • O formato de payload enviado pelo cliente como parte da solicitação HTTP não corresponde ao formato de codificação especificado no cabeçalho Content-Encoding .

Isso acontece porque o Apigee Edge não decodifica o payload usando a codificação especificada, já que o formato do payload não é o mesmo da codificação especificada no cabeçalho Content-Encoding.

Confira alguns exemplos de valores Content-Encoding compatíveis e como o Apigee Edge espera que o formato de payload seja nesses casos:

Cenário Content-Encoding Formato esperado do payload
Codificação única gzip

O formato Unix gzip.

Consulte Formato GZIP RFC1952.

Codificação única deflate

Esse formato usa a estrutura zlib com o algoritmo de compactação deflate.

Consulte RFC1950 e RFC1951.

Codificação múltipla

Codificação múltipla

Por exemplo, em casos em que a codificação é feita duas vezes, ela pode ser:

  • gzip, deflate
  • gzip, gzip
  • deflate, gzip
  • deflate, deflate
Várias codificações aplicadas ao payload na ordem em que aparecem no cabeçalho.

Confira as possíveis causas para esse erro:

Causa Descrição Instruções de solução de problemas aplicáveis para
O formato do payload da solicitação não corresponde à codificação especificada no cabeçalho "Content-Encoding" O formato do payload da solicitação enviado pelo cliente não está codificado ou não corresponde à codificação especificada no cabeçalho Content-Encoding. Usuários da nuvem pública e privada do Edge

Etapas comuns do diagnóstico

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

Monitoramento de APIs

Para diagnosticar o erro usando o API Monitoring:

  1. Faça login na interface do Apigee Edge como um usuário com um papel adequado.
  2. Mude para a organização em que você quer investigar o problema.

  3. Acesse a página Analisar > Monitoramento de APIs > Investigar.
  4. Selecione o período específico em que você observou os erros.
  5. Verifique se o filtro Proxy está definido como Todos.
  6. Crie um gráfico com Código de falha e Tempo.
  7. Selecione uma célula com o código de falha messaging.adaptors.http.flow.DecompressionFailureAtRequest, conforme mostrado abaixo:

    ( ampliar imagem)

  8. As informações sobre o código de falha messaging.adaptors.http.flow.DecompressionFailureAtRequest são mostradas conforme abaixo:

    ( ampliar imagem)

  9. Clique em Ver registros e expanda a linha com falha no erro 400.

    ( ampliar imagem)

  10. Na janela Registros, observe os seguintes detalhes:
    • Código de status:400
    • Origem da falha:proxy
    • Código de falha:messaging.adaptors.http.flow.DecompressionFailureAtRequest.
  11. Se a Origem da falha tiver o valor proxy, isso indica que o formato do payload da solicitação não corresponde à codificação compatível especificada no cabeçalho Content-Encoding.

Ferramenta Trace

Para diagnosticar o erro usando a ferramenta Trace:

  1. Ative a sessão de rastreamento e faça uma destas ações:
    1. Aguarde o erro 400 Bad Request ocorrer ou
    2. Se for possível reproduzir o problema, faça a chamada de API e reproduza 400 Bad Request.
  2. Verifique se a opção Mostrar todos os FlowInfos está ativada:

  3. Selecione uma das solicitações com falha e examine o rastreamento.
  4. Navegue pelas diferentes fases do rastreamento e localize onde a falha ocorreu.
  5. Normalmente, o erro é encontrado em um fluxo logo após a fase Solicitação recebida do cliente, conforme mostrado abaixo:

    ( ampliar imagem)

  6. Anote os valores das propriedades do rastreamento:

    • Erro:Decompression failure at request
    • error.class: com.apigee.rest.framework.BadRequestException
    • error.cause::Not in GZIP format

    O error.cause informa que o payload da solicitação NÃO está no formato GZIP. Isso significa que o Apigee Edge esperava que o payload da solicitação estivesse no formato GZIP, conforme especificado no cabeçalho Content-Encoding.

  7. Determine o valor do cabeçalho da solicitação Content-Encoding. Para isso, navegue até a fase Solicitação recebida do cliente, conforme mostrado abaixo:

    ( ampliar imagem)

    O valor do cabeçalho de solicitação Content-Encoding é gzip.

    O rastreamento de amostra acima mostra que a codificação especificada no cabeçalho da solicitação Content-Encoding é gzip. No entanto, o payload da solicitação não está no formato GZIP. Portanto, a Apigee não pode descompactar o payload usando gzip e retorna o erro Decompression failure at request.

  8. Anote o código de status e a mensagem de erro retornados pelo Apigee Edge navegando até

    para a fase Resposta enviada ao cliente no rastreamento, conforme mostrado abaixo:

    ( ampliar imagem)

    Observe os seguintes detalhes do rastreamento:

    • Código de status:400 Bad Request.
    • Conteúdo do erro: {"fault":{"faultstring":"Decompression failure at request","detail":{"errorcode":"messaging.adaptors.http.flow.DecompressionFailureAtRequest"}}}
  9. Navegue até a fase AX (dados do Analytics registrados) no rastreamento e clique nela.

  10. Role a tela para baixo até as seções Detalhes da fase e Cabeçalhos de erro e determine os valores de X-Apigee-fault-code e X-Apigee-fault-source, conforme mostrado abaixo:

    ( ampliar imagem)

  11. Você vai ver os valores de X-Apigee-fault-code e X-Apigee-fault-source como messaging.adaptors.http.flow.DecompressionFailureAtRequest e policy, indicando que o formato do payload da solicitação não correspondia à codificação especificada no cabeçalho Content-Encoding.
    Cabeçalhos de resposta Valor
    X-Apigee-fault-code messaging.adaptors.http.flow.DecompressionFailureAtRequest
    X-Apigee-fault-source policy

NGINX

Para diagnosticar o erro usando registros de acesso do NGINX:

  1. Se você for um usuário do Private Cloud, poderá usar os registros de acesso do NGINX para determinar as principais informações sobre erros HTTP 400.
  2. Verifique os 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.

  3. Pesquise para ver se há erros de 400 durante um período específico (se o problema aconteceu no passado) ou se ainda há solicitações com falha em 400.
  4. Se você encontrar erros de 400 com o X-Apigee-fault-code correspondente ao valor de messaging.adaptors.http.flow.DecompressionFailureAtRequest, determine o valor de X-Apigee-fault-source.

    Exemplo de erro 400 do registro de acesso do NGINX:

    A entrada de exemplo acima do registro de acesso do NGINX tem os seguintes valores para X-Apigee-fault-code e X-Apigee-fault-source:

    Cabeçalhos de resposta Valor
    X-Apigee-fault-code messaging.adaptors.http.flow.DecompressionFailureAtRequest
    X-Apigee-fault-source policy

Causa: o formato do payload da solicitação não corresponde à codificação especificada no cabeçalho "Content-Encoding"

Por padrão, o Apigee Edge sempre descompacta o payload se o cabeçalho da solicitação Content-Encoding contiver uma codificação válida e compatível. Portanto, espera-se que o formato do payload da solicitação corresponda à codificação especificada no cabeçalho da solicitação Content-Encoding. Se houver uma incompatibilidade, você vai receber esse erro.

Diagnóstico

  1. Determine o código de falha e a origem da falha do erro observado usando o monitoramento de API, a ferramenta Trace ou os registros de acesso do NGINX, conforme explicado em Etapas comuns de diagnóstico.
  2. Se o Código de falha for messaging.adaptors.http.flow.DecompressionFailureAtRequest e a Origem da falha tiver o valor policy ou proxy, isso indica que a solicitação enviada pelo aplicativo cliente tem uma carga útil que não corresponde à codificação compatível especificada no cabeçalho da solicitação Content-Encoding.
  3. É possível determinar a incompatibilidade como parte da solicitação HTTP usando um dos seguintes métodos:

    Mensagem de erro

    Para validar usando a mensagem de erro:

    1. Se você tiver acesso à mensagem de erro completa recebida do Apigee Edge, consulte faultstring.

      Exemplo de mensagem de erro:

      "faultstring":"Decompression failure at request"
    2. Na mensagem de erro acima, "Decompression failure at request" é exibido, o que implica que a solicitação não pôde ser descompactada usando a codificação especificada no cabeçalho Content-Encoding.

    Trace

    Para validar usando o Trace:

    1. Determine o valor do cabeçalho da solicitação Content-Encoding e da propriedade error.cause usando Trace, conforme explicado em Etapas comuns de diagnóstico.
    2. Os valores do rastreamento de amostra são os seguintes:

      • Content-Encoding:gzip
      • error.cause::Not in GZIP format

      O valor no cabeçalho da solicitação Content-Encoding é gzip. No entanto, o payload da solicitação não está no formato GZIP, conforme indicado por error.cause. Portanto, o Apigee Edge responde com 400 Bad Request e o código de erro messaging.adaptors.http.flow.DecompressionFailureAtRequest.

    Solicitação real

    Para validar usando a solicitação real:

    Se você tiver acesso à solicitação real feita pelo aplicativo cliente, siga estas etapas:

    1. Determine o valor transmitido ao cabeçalho da solicitação Content-Encoding.
    2. Determine o formato do payload enviado como parte da solicitação.
    3. Se o valor do cabeçalho Content-Encoding estiver na lista de codificações compatíveis, mas o formato do payload da solicitação não corresponder à codificação especificada no cabeçalho Content-Encoding, essa será a causa do problema.

      Exemplo de solicitação:

      curl -v "http://HOSTALIAS/v1/testgzip" -H "Content-Encoding: gzip" -X POST -d @request_payload.zip
      

      A solicitação de exemplo acima envia o valor gzip para o cabeçalho Content-Encoding, que é uma codificação compatível no Apigee Edge. No entanto, o payload da solicitação request_payload.zip está no formato ZIP. Portanto, essa solicitação falha com um código de status 400 Bad Request e o código de erro: messaging.adaptors.http.flow.DecompressionFailureAtRequest.

    Registros do processador de mensagens

    Para validar usando registros do processador de mensagens:

    Se você for um usuário do Cloud privado, poderá usar os registros do processador de mensagens para determinar as principais informações sobre erros HTTP 400.

    1. Determine o ID da mensagem da solicitação com falha usando o API Monitoring, a ferramenta Trace ou os registros de acesso do NGINX, conforme explicado em Etapas comuns de diagnóstico.
    2. Pesquise o ID da mensagem no registro do processador de mensagens:

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

    3. Você vai encontrar uma das seguintes exceções:

      Cenário 1

      Cenário 1: quando a solicitação de API tem o cabeçalho "Content-Encoding: gzip"

      2021-07-28 10:21:16,861  NIOThread@0 ERROR HTTP.SERVER -
      HTTPServer$Context.onInputException() : Message id:rt-57-1
      SSLClientChannel[Accepted: Remote:192.168.199.8:8443
      Local:192.168.80.234:44284]@28469 useCount=1 bytesRead=0
      bytesWritten=28764 age=2739893ms  lastIO=0ms
      isOpen=true.onExceptionRead exception: {}
      java.util.zip.ZipException: Not in GZIP format
      
      2021-07-28 10:21:16,862  NIOThread@0 ERROR ADAPTORS.HTTP.FLOW -
      AbstractRequestListener.onException() : Request:POST, uri:/test,
      message Id:rt-57-1, exception:java.util.zip.ZipException: Not in GZIP format,
      context:Context@71ea5ac input=ClientInputChannel(SSLClientChannel[Accepted:
      Remote:192.168.199.8:8443 Local:192.168.80.234:44284]@28469 useCount=1
      bytesRead=0 bytesWritten=28764 age=2739894ms  lastIO=0ms  isOpen=true)
      2021-07-28 10:21:16,862  NIOThread@0 INFO  HTTP.SERVICE -
      ExceptionHandler.handleException() :
      Exception java.util.zip.ZipException: Not in GZIP format occurred while writing
      to channel null
      2021-07-28 10:21:16,863  NIOThread@0 INFO  HTTP.SERVICE -
      ExceptionHandler.handleException() : Exception trace:
      java.util.zip.ZipException: Not in GZIP format
      

      A linha java.util.zip.ZipException: Not in GZIP format na mensagem de erro acima indica que o payload da solicitação não é enviado no formato GZIP, embora o Content-Encoding seja especificado como gzip. Portanto, o Apigee Edge gera a exceção e retorna um código de status 400 com o código de falha messaging.adaptors.http.flow.DecompressionFailureAtRequest para aplicativos clientes.

      Cenário 2

      Cenário 2: quando a solicitação de API tem o cabeçalho "Content-Encoding: deflate"

      2021-07-28 15:26:31,893  NIOThread@1 ERROR HTTP.SERVER -
      HTTPServer$Context.onInputException() : Message id:rt-47875-1
      SSLClientChannel[Accepted: Remote:192.168.199.8:8443
      Local:192.168.81.72:45954]@29276 useCount=1 bytesRead=0
      bytesWritten=37230 age=3498856ms  lastIO=1ms
      isOpen=true.onExceptionRead exception: {}
      java.util.zip.ZipException: incorrect header check
                        ….
      Caused by: java.util.zip.DataFormatException: incorrect header check
             ..
      2021-07-28 15:26:31,894  NIOThread@1 ERROR ADAPTORS.HTTP.FLOW -
      AbstractRequestListener.onException() : Request:POST, uri:/test,
      message Id:rrt-47875-1, exception:java.util.zip.ZipException:
      incorrect header check, context:Context@69b3ac45
      input=ClientInputChannel(SSLClientChannel[Accepted:
      Remote:192.168.199.8:8443 Local:192.168.81.72:45954]@29276
      useCount=1 byt	esRead=0 bytesWritten=37230 age=3498856ms
      lastIO=1ms  isOpen=true)
      

      As linhas java.util.zip.ZipException: incorrect header check e Caused by: java.util.zip.DataFormatException: incorrect header check na mensagem de erro acima indicam que o payload da solicitação não é enviado no formato deflate e não corresponde à codificação especificada no cabeçalho Content-Encoding de deflate. Portanto, o Apigee Edge gera a exceção e retorna um código de status 400 com o código de falha messaging.adaptors.http.flow.DecompressionFailureAtRequest para aplicativos clientes.

Resolução

  1. Se não houver necessidade do payload da solicitação compactada no fluxo de proxy de API no Apigee Edge e no servidor de back-end, não transmita o cabeçalho Content-Encoding. Se for necessário compactar o payload da solicitação, vá para a etapa 2.
  2. Verifique se o aplicativo cliente sempre envia o seguinte:
    • Qualquer uma das codificações compatíveis como valor do cabeçalho Content-Encoding na solicitação
    • O payload da solicitação no formato compatível com o Apigee Edge corresponde ao formato de codificação especificado no cabeçalho Content-Encoding.
  3. No exemplo discutido acima, o payload da solicitação está no formato ZIP, mas o cabeçalho da solicitação especifica Content-Encoding: gzip. Para corrigir o problema, envie o cabeçalho da solicitação como Content-Encoding: gzip e o payload da solicitação também no formato gzip:
    curl -v "https://HOSTALIAS/v1/testgzip" -H "Content-Encoding: gzip" -X POST -d @request_payload.gz
    

Especificação

O Apigee Edge responde com o código de status 400 Bad Request e o código de erro messaging.adaptors.http.flow.DecompressionFailureAtRequest, de acordo com as seguintes especificações da RFC:

Especificação
RFC 7231, seção 6.5.1
RFC 7231, seção 3.1.2.2

Se você ainda precisar de ajuda do suporte da Apigee, acesse Precisa de 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 400
  • Arquivo de rastreamento 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 rastreamento 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