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 quando você usa o Cato para executar uma consulta de API com ferramentas e software de API. Por exemplo, Altair e Postman.

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

Argumentos de API Necessários

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
- timeframe - período de tempo dos dados que a consulta retorna
- groupDevices - Para múltiplos sites e sites com múltiplos Sockets, combine as análises em um único Socket (para valor booleano true)
consulta accountSnapshot
- id - ID da Conta

Erros Comuns 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 ocorre quando você não fornece um valor booleano para um argumento. Por exemplo, groupInterfaces: , em vez de groupInterfaces: true,

Mensagem: Nome esperado, encontrado <caractere>

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, encontrado ( para o argumento accountSnapshot((id: 42). O formato correto para este argumento é accountSnapshot(id: 1941)

Mensagem: Nome esperado, encontrado <Inválido>

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

Por exemplo, o argumento timeFrame (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 produz este erro.

Erros Comuns GRAPH_QL_VALIDATION_FAILED

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

Mensagem: Tipo String esperado!, encontrado <número>

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

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

Mensagem: Tipo Int esperado!, encontrado \"<número>\"

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

Por exemplo, o argumento sites ids (accountSnapshot > sites) é um INT, então você NÃO deve usar aspas para o valor, ids: [2626] está correto e ids:["2626"] produz 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 GraphQL Cato.

Mensagem: erro de autenticação ou 403

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

Na Aplicativo de Gerenciamento Cato (Sistema > Gerenciamento de Acesso API), certifique-se de que:
- A chave API que você está usando ainda é válida (existe e não está expirada)
- Se a opção Permitir acesso de Endereços IP estiver configurada, o cliente API está realizando a chamada de um endereço IP ou intervalo específico permitido
Confirme que a chave está configurada corretamente nas configurações de cabeçalho HTTP para o software de consulta API: x-api-key: <valor da chave>, por exemplo, x-api-key: abcdef12345
Se o problema persistir, gere uma nova chave API e adicione-a ao software de consulta API

Este é um exemplo de cabeçalho HTTP válido para o Cliente API:

POST /api/v1/graphql2 HTTP/2
Host: api.catonetworks.com
User-Agent: curl/8.7.1
Accept: */*
Content-Type:application/json
x-api-key: abcdef123456789

Mensagem: não é possível separar dispositivos (groupDevices = false) quando vários sites são selecionados

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

Convertendo Dados de Análise de API

A API Cato retorna dados de tráfego em bytes. Para converter os dados em unidades maiores (como MB ou GB), você precisa dividir por valores exponenciais de 1024: 1024² para MB e 1024³ para GB.

Por exemplo, para converter 536,870,912,000 bytes em GB, divida por 1024³ para mostrar 500GB de dados.