414 URI de solicitação muito longo - TooBigLine

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 414 Request-URI Too Long com código de erro protocol.http.TooBigLine como resposta para chamadas de API.

Mensagem de erro

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

HTTP/1.1 414 Request-URI Too Long

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

{
   "fault":{
      "faultstring":"request line size exceeding 7,168",
      "detail":{
         "errorcode":"protocol.http.TooBigLine"
      }
   }
}

Observe que o faultstring na mensagem de erro acima contém o limite permitido para a linha de solicitação no Apigee Edge, que é 7168 bytes (7 KB).

Causas possíveis

Esse erro ocorre se o tamanho da linha de solicitação enviada pelo aplicativo cliente para o Apigee Edge como parte da solicitação HTTP for maior que o limite permitido no Apigee Edge.

Antes de analisarmos as possíveis causas desse erro, vamos entender o que significa a linha de solicitação e como verificar o tamanho dela.

Noções básicas sobre a linha de solicitação

Uma solicitação HTTP comum consiste em três partes:

1. Linha de solicitação
2. ( Conjunto de cabeçalhos HTTP )
3. [ Corpo ]

A linha de solicitação consiste em três partes, conforme mostrado abaixo.

Request-Line = <Method> <Request-URI> <HTTP-Version>

Quando uma solicitação HTTP é feita pelo aplicativo cliente para um servidor, a primeira linha que vai para o servidor contém a linha de solicitação descrita acima. Ela é seguida pelos cabeçalhos e pelo corpo/payload da solicitação.

A captura de tela de exemplo a seguir mostra uma solicitação curl típica, a parte Solicitação (junto com a linha de solicitação) e a parte Resposta.

Noções básicas sobre o tamanho da linha de solicitação

1. No exemplo discutido acima, a linha inicial (primeira linha) na solicitação, também chamada de linha de solicitação, é a seguinte:

   GET /test/ HTTP/1.1

   O tamanho da linha de solicitação é ~19 bytes já que ela contém 19 ASCII characters. Como isso está dentro do limite permitido no Apigee Edge, a solicitação é processada sem erros e você recebe uma resposta bem-sucedida.

2. Da mesma forma, se você analisar o faultstring na mensagem de erro mostrada acima, ele contém "request line size exceeding 7,168". Isso indica que a linha de solicitação na solicitação HTTP feita pelo cliente excedeu 7.168 bytes.

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 do payload da 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, a ferramenta Trace 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, 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 da linha de solicitação excedeu o limite permitido de 7 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 da linha de solicitação excedeu o limite permitido de 7 KB.

   Mensagem de erro de exemplo:

   "faultstring":"request line size exceeding 7,168"

   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 do URI transmitido na solicitação.

   2. Se você descobrir que o tamanho do URI é maior que o limite permitido no Apigee Edge, essa é a causa do problema.

      Exemplo de solicitação:

      curl http://<hostalias>/testtoobigline?_qparam=000000000000000000……..000000<trimmed> -k -X POST
      

      No caso acima, o valor do parâmetro de consulta qparam é maior que 7 KB, ou seja, contém mais de 7 mil caracteres ASCII.

      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 da linha 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 verificar se há erros 414 durante um período específico (se o problema aconteceu no passado) ou se ainda há solicitações com falha 414. Você pode usar as seguintes strings de pesquisa.

      grep -ri "exceeding"
      

      grep -ri "RequestURITooLong"
      

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

      2021-07-12 08:53:31,461  NIOThread@0 ERROR ADAPTORS.HTTP.FLOW -
      AbstractRequestListener.onException() : Request:null, uri:null,
      message Id:null, exception:com.apigee.errors.http.user.RequestURITooLong{
      code = protocol.http.TooBigLine, message = request line size exceeding 7,168,
      associated contexts = []}, context:Context@366f4217
      input=ClientInputChannel(SSLClientChannel[Accepted: Remote:192.168.195.90:8443
      Local:192.168.67.23:34256]@301912 useCount=1 bytesRead=0 bytesWritten=45849
      age=2254670ms lastIO=0ms isOpen=true)

      O texto message = request line size exceeding 7,168 na mensagem de erro acima indica que o tamanho do URI de solicitação é maior que 7 kB. Portanto, o Apigee Edge gera a exceção com.apigee.errors.http.user.RequestURITooLong e retorna 414 código de status com código de falha protocol.http.TooBigline para aplicativos clientes.

Resolução

Limites

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

1. Se você for um usuário da nuvem pública, o limite máximo para o tamanho da linha de solicitação e resposta será conforme documentado para Tamanho da linha 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 da linha de solicitação e resposta (embora não seja uma prática recomendada). É possível determinar o limite máximo de tamanho da linha 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.line.limit foi atualizada com um novo valor nos processadores de mensagens.

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

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

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

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

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

   Isso indica que o limite para o tamanho da linha de solicitação configurado na Apigee for Private Cloud é de 7 KB.

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 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 414
• 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 414

• 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