431 Campos de cabeçalho da solicitação muito grandes - TooBigHeaders

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 431 Request Header Fields Too Large com o código de erro protocol.http.TooBigHeaders como resposta para chamadas de API.

Mensagem de erro

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

HTTP/1.1 431 Request Header Fields Too Large

Além disso, você pode observar a seguinte mensagem de erro:

{
   "fault":{
      "faultstring":"request headers size exceeding 25,600",
      "detail":{
         "errorcode":"protocol.http.TooBigHeaders"
      }
   }
}

Causas possíveis

Esse erro ocorre se o tamanho total de todos os cabeçalhos de solicitação enviados pelo aplicativo cliente para o Apigee Edge como parte da solicitação HTTP for maior que o limite permitido no Apigee Edge, conforme RFC 6585, seção 5: 431 campos de cabeçalho de solicitação muito grandes.

Confira as possíveis causas desse erro:

Etapas comuns do diagnóstico

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

Causa: o tamanho dos cabeçalhos de solicitação é maior que o limite permitido

Diagnóstico

1. Determine o código de falha, a origem da falha e o tamanho do comprimento da solicitação para o erro observado usando o monitoramento de APIs ou os registros de acesso do NGINX, conforme explicado em Etapas comuns do diagnóstico.
2. Se a origem da falha tiver o valor apigee ou MP, o código de falha tiver o valor protocol.http.TooBigHeaders, e o comprimento da solicitação for maior que 25 KB, isso indica que o tamanho da solicitação enviada pelo aplicativo cliente para a Apigee é maior que o limite permitido no Apigee Edge.
3. É possível validar se o tamanho dos cabeçalhos de solicitação excedeu o limite permitido de 25 KB usando um dos seguintes métodos:

   Mensagem de erro

   Para validar usando a mensagem de erro:

   Se você tiver acesso à mensagem de erro completa recebida do Apigee Edge, então consulte o faultstring. O faultstring indica que o tamanho total dos cabeçalhos de solicitação excedeu o limite permitido de 25 KB.

   Exemplo de mensagem de erro:

   "faultstring":"request headers size exceeding 25,600"

   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. Verifique o tamanho dos cabeçalhos transmitidos na solicitação.

   2. Se você descobrir que o tamanho total dos cabeçalhos é maior que o limite permitido no Apigee Edge, essa é a causa do problema.

      Exemplo de solicitação:

      curl -v https://HOSTALIAS/test -H "header0: 000000000000000000……..000000<trimmed>" -H "header1: 111111111111111111……..111111<trimmed>" -H "header2: 222222222222222222……..222222<trimmed>"-H "header3: 333333333333333333……..333333<trimmed>"
      

      No caso acima, o tamanho total dos cabeçalhos header0, header1, header2, e header3 é maior que 25 KB, ou seja, contém mais de 25 mil caracteres ASCII (bytes).

      Se você estiver usando outro cliente, revise os registros do cliente e tente descobrir o tamanho da linha de solicitação que está sendo enviada para o Apigee Edge.

   Registros do processador de mensagens

   Para validar usando registros do processador de mensagens:

   Se você for um usuário do Private Cloud, poderá usar os registros do processador de mensagens para validar se o tamanho dos cabeçalhos de solicitação excedeu o limite permitido no Apigee Edge.

   1. Verifique os registros do processador de mensagens:

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

   2. Pesquise para ver se há erros 431 durante um período específico (se o problema aconteceu no passado) ou se ainda há solicitações com falha 431. Você pode usar as seguintes strings de pesquisa.

      grep -ri "exceeding"
      

      grep -ri "RequestHeadersTooLarge"
      

   3. Você vai encontrar linhas de system.log semelhantes a estas:

      2021-07-27 08:30:28,419  NIOThread@1 ERROR ADAPTORS.HTTP.FLOW -
      AbstractRequestListener.onException() :
      Request:GET, uri:/test/, message Id:null,
      exception:com.apigee.errors.http.user.RequestHeadersTooLarge{
      code = protocol.http.TooBigHeaders, message = request headers size
      exceeding 25,600, associated contexts = []}, context:Context@9c5903
      input=ClientInputChannel(SSLClientChannel[Accepted:
      Remote:192.168.205.251:8443 Local:192.168.67.23:22188]@25130
      useCount=1 bytesRead=0 bytesWritten=15367 age=667062ms  lastIO=0ms
      isOpen=true)

      O texto message = request headers size exceeding 25,600 na mensagem de erro acima indica que o tamanho total dos cabeçalhos de solicitação é maior que 25 KB. Portanto, o Apigee Edge gera a exceção com.apigee.errors.http.user.RequestHeadersTooLarge e retorna o código de status 431 com o código de falha protocol.http.TooBigHeaders para aplicativos clientes.

Resolução

Limites

A Apigee espera que o aplicativo cliente e o servidor de back-end não enviem cabeçalhos de solicitação/resposta com tamanhos maiores que o limite permitido, conforme documentado para o limite de tamanho do cabeçalho de solicitação/resposta em Limites do Apigee Edge.

1. Se você for um usuário do Cloud público, o limite máximo para o tamanho dos cabeçalhos de solicitação e resposta será documentado para o tamanho do cabeçalho de solicitação/resposta em Limites do Apigee Edge.
2. Se você for um usuário do Private Cloud, poderá ter modificado o limite máximo padrão para o tamanho dos cabeçalhos de solicitação e resposta (embora não seja uma prática recomendada). É possível determinar o limite máximo de tamanho do cabeçalho de solicitação seguindo as instruções em Como verificar o limite atual.

Como verificar o limite atual?

Esta seção explica como verificar se a propriedade HTTPRequest.headers.limit foi atualizada com um novo valor nos processadores de mensagens.

1. Na máquina do processador de mensagens, pesquise a propriedade HTTPRequest.headers.limit no diretório /opt/apigee/edge-message-processor/conf e verifique qual valor foi definido, conforme mostrado abaixo:

   grep -ri "HTTPRequest.headers.limit" /opt/apigee/edge-message-processor/conf
   

2. O resultado de amostra do comando acima é o seguinte:

   /opt/apigee/edge-message-processor/conf/http.properties:HTTPRequest.headers.limit=25k

3. No exemplo de saída acima, observe que a propriedade HTTPRequest.headers.limit foi definida com o valor 25k em http.properties.

   Isso indica que o limite para o tamanho do cabeçalho de solicitação configurado na Apigee para o Private Cloud é de 25 KB.

Especificação

O Apigee Edge espera que o aplicativo cliente não envie cabeçalhos de tamanho grande como parte do solicitação. Caso a solicitação contenha cabeçalhos com tamanho total maior que o limite especificado, a Apigee vai gerar 431 Request Header Fields Too Large de acordo com as seguintes especificações da RFC:

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

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 do Cloud público, 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 431
• Arquivo de trace para as solicitações de API

Se você for um usuário do Private Cloud, forneça as seguintes informações:

• Mensagem de erro completa observada para as solicitações com falha
• Nome da organização
• Nome do ambiente
• Pacote de proxy de API
• Arquivo de trace para as solicitações de API com falha
• Comando curl completo usado para reproduzir o erro 431

• 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