Dépannage des appels API 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 et au codage API ne sont pas pris en charge.

Arguments API Requis

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

  • requête accountMetrics

    • id - ID de compte

    • timeframe - période de données que la requête retourne

    • groupDevices - Pour plusieurs sites, et sites avec plusieurs Appareils, combinez les analyses dans un seul Appareil (pour la valeur booléenne true)

  • requête accountSnapshot

    • id - ID de compte

Erreurs courantes GRAPHQL_PARSE_FAILED

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

Message : Caractère inattendu « ) »

Il y a une parenthèse en trop dans la requête. Souvent, cette erreur est causée lorsque vous ne fournissez pas une 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 affiche un caractère 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 un problème avec une valeur invalide.

Par exemple, l'argument timeFrame (accountMetrics) dans l'API Cato utilise des guillemets pour la norme date et 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 STRING, vous devez donc 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, vous ne devez donc PAS utiliser de guillemets pour la valeur, ids: [2626] est correct et ids:["2626"] produit cette erreur.

Messages d'erreur API

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

Message : erreur d'authentification ou 403

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

  • Dans l'Application de gestion Cato (Système > Gestion de l'accès API), assurez-vous que :

    • La clé API que vous utilisez est toujours valide (existe et n'a pas expiré)

    • Si l'option Autoriser l'accès depuis des adresses IP est définie, le client API effectue l'appel depuis une adresse IP ou une plage spécifiquement autorisée
  • Confirmez que la clé est correctement configurée dans les paramètres de l'en-tête HTTP pour le logiciel de requête API : x-api-key: <valeur de la clé>, par exemple, x-api-key: abcdef12345

  • Si le problème persiste, générez une nouvelle clé API et ajoutez-la au logiciel de requête API

Ceci est un exemple d'en-tête HTTP valide pour le Client 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

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.

Conversion des données analytiques API

L'API Cato renvoie les données de trafic en octets. Pour convertir les données en unités plus grandes (comme MB ou GB), vous devez diviser par des valeurs exponentielles de 1024 : 10242 pour MB, et 10243 pour GB.

Par exemple, pour convertir 536 870 912 000 octets en GB, divisez par 10243 pour montrer 500GB de données.

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 1 sur 1

0 commentaire