Dépannage des appels API de Cato

Cet article fournit des suggestions de dépannage pour les erreurs courantes qui peuvent survenir lorsque vous utilisez Cato pour exécuter une requête API avec des outils et logiciels API. Par exemple, Altair et Postman.

Les problèmes liés aux scripts API et au codage ne sont pas pris en charge.

Arguments requis de l'API

Ce sont les arguments que vous devez inclure dans la requête API. Lorsque vous supprimez un argument optionnel de la requête API, la valeur par défaut est utilisée.

• Requête accountMetrics
  • id - ID du compte
  • période - période de temps des données que la requête retourne
  • groupDevices - Pour plusieurs sites, et sites avec plusieurs Sockets, combinez les analyses en un seul Socket (pour la valeur booléenne true)
• Requête accountSnapshot
  • id - ID du compte

Erreurs courantes GRAPHQL_PARSE_FAILED

Cette section explique quelques exemples courants de messages d'erreur liés au schéma GraphQL de Cato.

Message : Parenthèse inattendue )

Il y a une parenthèse supplémentaire dans la requête. Souvent, cette erreur est causée lorsque vous ne fournissez pas de valeur booléenne pour un argument. Par exemple, groupInterfaces: , au lieu de groupInterfaces: true,

Message : Nom attendu, trouvé <character>

Le fichier JSON n'est pas formaté correctement. Le message montre un caractère qui est lié au caractère manquant ou en trop. Par exemple, Nom attendu, trouvé ( pour l'argument accountSnapshot((id: 42). Le format correct pour cet argument est accountSnapshot(id: 1941)

Message : Nom attendu, trouvé <Invalid>

Le message d'erreur indique qu'il y a une valeur invalide.

Par exemple, l'argument timeFrame (accountMetrics) dans l'API de Cato utilise des guillemets pour le standard de date et d'heure ISO 8601, timeFrame: "last.P1D" est correct et timeFrame: last.P1D produit cette erreur.

Erreurs courantes GRAPH_QL_VALIDATION_FAILED

Cette section explique quelques exemples courants de messages d'erreur liés au format incorrect des arguments dans la requête.

Message : Type String! attendu, trouvé <number>

Le message d'erreur indique qu'un argument a une valeur invalide, généralement liée au format de l'argument.

Par exemple, l'argument sites ids (accountMetrics > sites) est une CHAÎNE, donc vous devez utiliser des guillemets pour la valeur, ids: ["4242"] est correct et ids:[4242] produit cette erreur.

Message : Type Int! attendu, trouvé \"<number>\"

Le message d'erreur indique qu'un argument a une valeur invalide, généralement liée au format de l'argument.

Par exemple, l'argument sites ids (accountSnapshot > sites) est un INT, donc vous ne devez PAS utiliser de guillemets pour la valeur, ids: [2626] est correct et ids:["2626"] produit cette erreur.

Messages d'erreur de l'API

Cette section explique les messages d'erreur courants qui ne sont pas spécifiquement liés au schéma ou au format GraphQL de Cato.

Message : erreur d'authentification

Il y a un problème avec la clé API pour votre compte. Solutions suggérées :

• Dans l'application de gestion Cato (System > Management de l'accès API), assurez-vous que la clé API que vous utilisez est toujours valide. La clé est supprimée lorsqu'elle est révoquée.
• Confirmez que la clé est configurée correctement dans les paramètres d'en-tête HTTP pour le logiciel de requête API : x-api-key <valeur de la clé>
• Si le problème persiste, générez une nouvelle clé API et ajoutez-la au logiciel de requête API

Message : impossible de séparer les appareils (groupDevices = false) lorsque plusieurs sites sont sélectionnés

La valeur pour l'argument groupDevices (accountMetrics) doit être true lorsque la requête inclut plusieurs sites.

Erreur générale de l'API lors de l'exécution de scripts pendant la fenêtre de maintenance

Pendant la fenêtre de maintenance (généralement tous les deux dimanches), Cato met à jour le serveur API et il peut être temporairement indisponible jusqu'à deux minutes. Si vous exécutez des scripts API récursifs, alors pendant une fenêtre de maintenance le script peut échouer et renvoyer une erreur. Il n'y a aucun impact sur les données de votre compte.

Pour des informations à jour sur les fenêtres de maintenance programmées et le statut de Cato Cloud, voir https://status.catonetworks.com/.

Erreur générale de l'API pour délai d'attente avec le serveur API

S'il y a un délai de plus de 40 secondes pour une requête API, alors il y a un délai d'attente avec le serveur API et vous devez exécuter de nouveau la requête. Nous vous recommandons d'inclure un mécanisme de réessai avec un script API pour votre compte Cato. Ce mécanisme devrait inclure au moins deux tentatives de réessai et attendre au moins 30 secondes entre chaque tentative.