Nous vous recommandons fortement de revoir la politique de support pour le Cato API avant de commencer à utiliser le Cato API.

Vue d'ensemble des accountMetrics

La requête accountMetrics vous aide à analyser l'état et la qualité des connexions des sites et des utilisateurs SDP au Cato Cloud. Ces données concernent le trafic à l'intérieur du tunnel DTLS entre le site et le Cato Cloud.

accountMetrics montre des métriques historiques, des statiques et des analyses pour le compte. Il renvoie des données similaires à la fenêtre Connectivité du site dans l'application de gestion Cato.

Pour les comptes des revendeurs, vous pouvez créer des clés API distinctes dans chaque compte client que vous connectez au Cato API. Pour en savoir plus sur la limitation du débit et la requête API accountMetrics, consultez Comprendre la limitation de débit du Cato API.

Utilisation de la granularité du seau et des limites de requêtes API

Il y a une limite maximale de 100 000 éléments retournés par requête API accountMetrics. Si une requête atteint cette limite, elle ne renvoie plus de données et un message d'erreur est affiché.

Cato calcule cette limite en multipliant les éléments suivants :

• Nombre total de sites plus utilisateurs VPN
• Nombre de métriques (étiquettes API/télémétrie)
• Nombre de seaux

En d'autres termes, la somme de (sites + utilisateurs VPN) * (métriques) * (seaux) doit être inférieure à 100 000. Par exemple, la requête suivante produira une erreur :

• 10 sites
• 140 utilisateurs VPN
• 5 métriques
• 150 seaux

(10 + 140) * 5 * 150 = 112 500 éléments dans la requête. Dans cet exemple, vous pouvez réduire le nombre de seaux pour exécuter la requête avec succès.

Pour en savoir plus sur les types d'étiquettes API, consultez Cato API - AccountMetrics > Timeseries.

Calcul de la granularité minimale pour une requête

Cette section explique comment calculer la granularité minimale (taille du seau) basée sur la période de temps pour la requête.

1. Période de temps - Convertir la période de temps en secondes
2. Limite du seau - Calculer la limite du seau basée sur 100000 / ( (sites + utilisateurs VPN) * (métriques) )
3. Granularité minimale = (période de temps) / (limite du seau)

Par exemple, la première ligne du tableau ci-dessous montre la limite de requête pour 7 jours, 100 sites et utilisateurs VPN, avec 5 métriques :

• 7 jours = 604 800 secondes
• 200 seaux = 10000 / (100) * (5)
• 3024 secondes de granularité minimale = 604800 / 200

Le tableau suivant montre des exemples de paramètres pour la requête accountMetrics avec la granularité minimale du seau :

Détails pour les champs accountMetrics

Voici les détails que les champs accountMetrics peuvent renvoyer pour la requête :

• ID - ID du compte
• from - heure de début
• to - heure de fin
• granularité - taille du seau
• sites -données qui sont retournées pour chaque site (array avec requêtes et champs imbriqués)
• timeseries - période de temps pour les données, et définit la relation entre les seaux et les données (array avec requêtes et champs imbriqués)

accountMetrics ID

Le champ ID affiche l'ID interne unique du compte.

Cet ID de compte n'est pas affiché dans l'application de gestion Cato, il s'agit du numéro dans l'URL de l'application de gestion Cato. Par exemple, l'ID de compte est 26 pour l'URL suivante : https://cc2.catonetworks.com/#!/26/topology.

accountMetrics From

Le champ From affiche l'heure de début pour les données de requête et est défini dans l'argument timeFrame.

accountMetrics To

Le champ To affiche l'heure de fin pour les données de requête et est défini dans l'argument timeFrame.

accountMetrics Granularity

Le champ Granularity montre la durée en secondes pour un seul seau de métriques. Le nombre de seaux est défini dans l'argument timeseries >_bucket.

La granularité est calculée selon la formule suivante : timeFrame/buckets. Par exemple, si la requête renvoie cinq minutes de données (timeFrame) avec 60 seaux, alors la granularité (taille du seau) est de 5 secondes (300 secondes / 60).

La granularité minimale pour un seau est de 5 secondes. Lorsque la granularité du seau est inférieure à 5 secondes, il est possible qu'aucune donnée ne soit retournée pour ce seau.

Pour en savoir plus sur le champ Granularity, consultez Travailler avec accountMetrics > Granularity.

accountMetrics Sites

Le champ Sites contient des données liées à un ou plusieurs sites dans le compte. Vous pouvez également spécifier des données pour les utilisateurs VPN avec leurs ID utilisateur.

Pour en savoir plus sur le champ Sites pour accountMetrics, consultez Cato API - AccountMetrics > Sites.

accountMetrics Timeseries

Montre les métriques pour le compte selon la période de temps spécifiée (seaux) dans la requête, et inclut des statistiques et métriques historiques. Ces données sont similaires à la fenêtre du champ Connectivité du site dans l'application de gestion Cato pour chaque site.

Pour en savoir plus sur le champ timeseries pour accountMetrics, consultez Cato API - AccountMetrics > Timeseries.

Arguments pour les accountMetrics

Voici les arguments que vous pouvez passer et définir les données retournées par la requête :

• accountID - ID du compte
• ID - ID du compte (argument hérité)
• timeFrame - heure de début et de fin de la requête
• groupInterfaces - Combiner les analyses pour les liens en un seul lien (pour valeur booléenne true)
• groupDevices - Pour plusieurs sites, et un seul site avec plusieurs Sockets, combiner les analyses en une seule Socket (pour valeur booléenne true)

Argument accountMetrics accountID

Entrez l'ID du compte pour les données que la requête retourne. Cet argument est obligatoire.

Cet ID de compte n'est pas affiché dans l'application de gestion Cato, il s'agit du numéro dans l'URL de l'application de gestion Cato. Par exemple, l'ID de compte est 26 pour l'URL suivante : https://cc2.catonetworks.com/#!/26/topology.

Argument accountMetrics timeFrame

Entrez la période de temps pour les données que la requête retourne. L'argument est au format <type>.<valeur de temps>. Cet argument est obligatoire.

Voici les options prises en charge pour définir la période de temps :

• dernier.<durée> - La valeur <durée> pour le type dernier est selon ISO-8601 et renvoie des données pour les temps spécifiques précédents. Par exemple :
  • timeFrame = dernier.PT5M montre les 5 minutes précédentes
  • timeFrame = dernier.PT2H montre les 2 heures précédentes
  • timeFrame = dernier.P1D montre le jour précédent 1
  • timeFrame = dernier.P3M montre les 3 mois précédents
  • timeFrame = dernier.P1Y montre l'année précédente 1
• utc.<spec-temps-court> - La période de temps combine une date de début et de fin au format AA-MM-JJ/hh:mm:ss selon le fuseau horaire spécifié. Vous devez entrer toutes les valeurs de date et d'heure pour l'argument. Par exemple :
  • timeFrame = utc.2020-02-{11/04:50:00--21/04:50:00} montre 10 jours de données analytiques du 11 février 2020 4:50:00 am au 21 février 2020 4:50:00 am
  • timeFrame = utc.2020-02-11/{04:50:15--16:50:15} montre 12 heures de données analytiques le 11 février 2020, de 4:50:15 am à 16:50:15 pm
  • timeFrame = utc.2020-{02-11/04:50:00--04-11/04:50:00} montre 2 mois de données analytiques du 11 février 2020 4:50:00 am au 11 avril 4:50:00 am
  • timeFrame = utc.{2019-10-01/04:50:00--2020-02-01/04:50:00} montre 4 mois de données analytiques du 1er octobre 2019 4:50:00 am au 11 février 2020 4:50:00 am

    Ce format vous permet de configurer une période de temps qui inclut plus d'une année civile

Pour en savoir plus sur l'argument timeFrame et le champ Granularity, consultez Travailler avec accountMetrics > Granularity.

Argument accountMetrics groupInterfaces

Lorsque l'argument booléen groupInterfaces est défini sur true, les données pour toutes les interfaces sont agrégées en une seule interface.

Argument accountMetrics groupDevices

Lorsque l'argument booléen groupDevices est défini sur true, les analyses pour toutes les prises (généralement deux en haute disponibilité) sont agrégées en un seul résultat. Pour de meilleurs résultats pour les prises agrégées, nous recommandons qu'il y ait des noms et des fonctionnalités cohérents (par exemple Destination) pour les liens sur les deux prises.