Resolução de Problemas de Chamadas de API Cato

Este artigo fornece sugestões de solução de problemas para erros comuns que podem ocorrer ao usar o Cato para executar uma consulta de API com ferramentas e software de API. Por exemplo, Altair e Postman.

Problemas relacionados a scripts de API e codificação não são suportados.

Argumentos Obrigatórios da API

Estes são os argumentos que você deve incluir na consulta de API. Quando você remove um argumento opcional da consulta de API, o valor padrão é usado.

• consulta accountMetrics
  • id - ID da Conta
  • período de tempo - período de tempo dos dados que a consulta retorna
  • groupDevices - Para múltiplos locais, e locais com múltiplos Sockets, combine as análises em um único Socket (para o valor booleano true)
• consulta accountSnapshot
  • id - ID da Conta

Erros Comuns de GRAPHQL_PARSE_FAILED

Esta seção explica alguns exemplos comuns de mensagens de erro relacionadas ao esquema Cato GraphQL.

Mensagem: Parêntese inesperado )

Há um parêntese extra na consulta. Frequentemente, esse erro é causado quando você não fornece um valor booleano para um argumento. Por exemplo, groupInterfaces: , em vez de groupInterfaces: true,

Mensagem: Nome Esperado, encontrou <character>

O arquivo JSON não está formatado corretamente. A mensagem mostra um caractere que está relacionado ao caractere ausente ou extra. Por exemplo, Nome Esperado, encontrou ( para o argumento accountSnapshot((id: 42). O formato correto para este argumento é accountSnapshot(id: 1941)

Mensagem: Nome Esperado, encontrou <Invalid>

A mensagem de erro indica que há um valor inválido.

Por exemplo, o argumento período de tempo (accountMetrics) na API Cato usa aspas para o padrão de data e hora ISO 8601, timeFrame: "last.P1D" está correto e timeFrame: last.P1D gera este erro.

Erros Comuns de GRAPH_QL_VALIDATION_FAILED

Esta seção explica alguns exemplos comuns de mensagens de erro relacionadas ao formato incorreto de argumentos na consulta.

Mensagem: Tipo String! Esperado, encontrou <number>

A mensagem de erro indica que um argumento tem um valor inválido, geralmente relacionado ao formato do argumento.

Por exemplo, o argumento ids de sites (accountMetrics > sites) é uma STRING, então você deve usar aspas para o valor, ids: ["4242"] está correto e ids:[4242] gera este erro.

Mensagem: Tipo Int! Esperado, encontrou \"<number>\"

A mensagem de erro indica que um argumento tem um valor inválido, geralmente relacionado ao formato do argumento.

Por exemplo, o argumento ids de sites (accountSnapshot > sites) é um INT, então você NÃO deve usar aspas para o valor, ids: [2626] está correto e ids:["2626"] gera este erro.

Mensagens de Erro de API

Esta seção explica mensagens de erro comuns que não estão especificamente relacionadas ao esquema ou formato Cato GraphQL.

Mensagem: Erro de autenticação

Há um problema com a Chave API para sua conta. Soluções sugeridas:

• No Aplicativo de Gerenciamento Cato (Sistema > Gerenciamento de Acesso à API), certifique-se de que a Chave API que você está usando ainda é válida. A chave é excluída quando é revogada.
• Confirme que a chave está configurada corretamente nas configurações de cabeçalho HTTP para o software de consulta de API: x-api-key <valor da chave>
• Se o problema continuar, gere uma nova Chave API e adicione-a ao software de consulta de API

Mensagem: não é possível separar dispositivos (groupDevices = false) quando múltiplos sites são selecionados

O valor para o argumento groupDevices (accountMetrics) deve ser true quando a consulta inclui múltiplos locais.

Erro Geral de API ao Executar Scripts durante a Janela de Manutenção

Durante a janela de manutenção (geralmente a cada dois domingos), Cato atualiza o servidor da API e pode estar temporariamente indisponível por até dois minutos. Se você estiver executando scripts de API recursivos, durante uma janela de manutenção o script pode falhar e retornar um erro. Não há impacto nos dados para sua conta.

Para informações atualizadas sobre as janelas de manutenção agendadas e o status do Cato Cloud, consulte https://status.catonetworks.com/.

Erro Geral de API para Timeout com o Servidor da API

Se houver um atraso de mais de 40 segundos para uma consulta de API, então há um timeout com o servidor da API e você precisa executar a consulta novamente. Recomendamos que você inclua um mecanismo de tentativa em um script de API para sua Conta Cato. Este mecanismo deve incluir pelo menos duas tentativas de repetição e aguardar pelo menos 30 segundos entre cada tentativa de repetição.