Cato API - AccountMetrics > Sites > Interfaces

Prev Next

AccountMetrics > Sites > Interfaces

Les champs AccountMetrics > Sites > Interfaces contiennent des données relatives aux liens WAN du Socket pour un site.

Champs InterfaceMetrics

Les champs InterfaceMetrics contiennent des données pour les liens WAN du Socket. Voici les détails et les champs de la requête :

  • metrics - données de trafic pour le lien (tableau avec champs imbriqués)

  • name - nom du lien dans l'application de gestion Cato

  • timeseries - période pour les données, et définit la relation entre les compartiments et les données (tableau avec requêtes et champs imbriqués)

  • annotations - annotation de l'horodatage qui montre un incrément de temps pour une interface utilisateur graphique (tableau avec requêtes et champs imbriqués)

  • periods - objet représentant une durée de temps spécifique (tableau avec champs imbriqués)

  • info (SocketInterface) - données relatives au lien, telles que l'adresse IP de la Passerelle (tableau avec champs imbriqués)

  • remoteIPinfo - données relatives à l'adresse IP du lien, telles que le code pays (tableau avec champs imbriqués)

  • IPDistante - Adresse IP de l'ISP pour ce lien

  • socketInfo - données relatives aux sites Socket et vSocket, telles que le numéro de série et la version du Socket (tableau avec champs imbriqués)

  • ipsecInfo - données relatives aux sites IPsec, telles que la version IKE (tableau avec champs imbriqués)

  • interfaceInfo - informations de configuration de base sur l'Interface de Socket (tableau avec champs imbriqués)

Métriques (InterfaceMetrics)

Le champ Metrics montre les analyses de trafic pour les liens WAN . Ce sont les détails des champs :

  • duration - durée totale des données du Socket

  • granularity - durée en secondes pour un seul compartiment de métadonnées

  • bytesDownstream - trafic descendant total (du Cloud Cato vers le Socket)

  • bytesUpstream - trafic montant total (du Socket vers le Cloud Cato)

  • bytesTotal - trafic total pour le Socket

  • lostDownstream - nombre de paquets perdus pour le trafic descendant

  • lostDownstreamPcnt - pourcentage de paquets perdus pour le trafic descendant

  • lostUpstream - nombre de paquets perdus pour le trafic montant

  • lostUpstreamPcnt - pourcentage de paquets perdus pour le trafic montant

  • packetsDownstream - paquets descendants totaux

  • packetsUpstream - paquets montants totaux

  • gigueMontante - gigue pour le trafic montant (différence de délai en millisecondes (ms) entre les paquets de données)

  • gigueDescendante - gigue pour le trafic descendant (différence de délai en millisecondes (ms) entre les paquets de données)

  • packetsDiscardedDownstream - paquets totaux rejetés pour le trafic descendant

  • packetsDiscardedUpstream - paquets totaux rejetés pour le trafic montant

  • rtt - temps de trajet aller-retour du Socket vers le Cloud Cato

Argument toRate

Lorsque l'argument booléen toRate est défini sur true, les données sont renvoyées par seconde. Lorsque l'argument est défini sur false, la requête retourne les données pour toute la période de temps.

L'argument toRate ne s'applique qu'aux types de données en octets, il ne s'applique pas au RTT, à l'état de santé, etc.

Nom

Le champ Nom indique le nom du lien configuré dans l'application de gestion Cato (Configuration > Sites > Socket Configuration).

Timeseries

Les champs de séries temporelles InterfaceMetrics montrent les métriques pour le lien selon la période spécifiée (compartiments) dans la requête. Inclut des statistiques et métriques historiques et proches du temps réel.

Les détails des champs et des arguments de séries temporelles InterfaceMetrics sont les mêmes que pour les séries temporelles AccountMetrics, voir Cato API - AccountMetrics > Timeseries.

Annotations

Les champs et arguments Annotations montrent les événements spécifiques selon l'heure et le type d'événement. Ce sont les détails des champs :

  • time - horodatage de l'événement

  • label - description de l'événement

  • shortLabel - brève description de l'événement

  • type - type d'événement

    • popChange - le site se connecte à un autre PoP

    • roleChange - changement pour le rôle de statut HA 

    • remoteIPChange - l'adresse IP du FAI (IP distante) a changé

    • generic - autres événements inclus dans les annotations

Argument Annotations Types

Spécifiez le type d'événement inclus dans la requête : popChange, roleChange, ou generic.

Périodes

Les champs Périodes montrent les métriques de Type de Période pour la durée spécifiée. Ce sont les détails des champs :

  • duration - Un tuple de deux nombres représentant le temps de début et de fin (en ms) selon l'index pour l'index du compartiment de début et de fin

  • title - Étiquette qui décrit les métriques

  • type - Un tableau enum qui identifie le type de données pour cette période :

    • packeLoss- perte de paquets due à un problème de connectivité

    • missingData - pas de données disponibles pour la période

    • passiveLink - le lien est en mode veille et ne passe pas de trafic

    • active - le lien est en charge active et passe du trafic

    • overflowed - certains paquets ont été mis en file d'attente et envoyés après un délai

    • congested - certains paquets ont été rejetés car ils ont expiré dans la file d'attente

    • lastmilePacketLoss - perte de paquets mesurée entre le Socket et le PoP

    • lastmileLatency - latence mesurée entre le Socket et le PoP

    • generic - quelque chose a affecté le lien depuis un inconnu

    • pop - PoP spécifique auquel le lien est actuellement connecté

remoteIPInfo

Les champs remoteIPInfo montrent les données relatives à l'adresse IP pour le lien. Voici les détails des champs relatifs à l'adresse IP :

  • ip - adresse IP du lien

  • countryCode - code pays ISO de géolocalisation

  • countryName - nom du pays de géolocalisation

  • city - ville de géolocalisation

  • state - état de géolocalisation

  • provider - fournisseur d'accès Internet

  • latitude - latitude de géolocalisation pour le FAI

  • longitude - longitude de géolocalisation pour le FAI

remoteIP

Le champ remoteIP montre l'adresse IP du lien, sans les données supplémentaires de remoteIPInfo.

infosSocket

Le champ socketInfo montre des données sur le socket, telles que le numéro de version et le numéro de série. Ce sont les détails des champs :

  • id - ID unique pour Socket

  • série - numéro de série pour le socket

  • estPrincipal - pour les configurations HA , quand cette valeur booléenne est vraie, ceci est le socket principal

  • plateforme - Montre le type de socket0:

    • non_défini - aucune plateforme définie pour le socket

    • VM - valeur héritée

    • X1 - valeur héritée

    • X1500 - Socket X1500

    • NATIF - valeur héritée

    • X1500_BR2 - À déterminer

    • X1700 - Socket X1700

    • AWS1500 - AWS vSocket

    • RPI64 - valeur héritée

    • AZ1500 - Azure vSocket

    • ESX1500 - VMware ESX vSocket

  • version - numéro de version logiciel actuellement installé sur le Socket

  • tempsMiseÀJourVersion - horodatage lorsque le socket a été mis à niveau vers la version matérielle actuelle

ipsecInfo

Le champ ipsecInfo montre les données concernant les paramètres de connexion pour le site IPsec. Ce sont les détails des champs :

  • isPrimary - pour les configurations HA , lorsque cette valeur booléenne est vraie, il s'agit du pare-feu IPsec principal ou de l'appareil de routage

  • catoIP - L'adresse IP source pour le tunnel IPsec dans le Cato Cloud

  • remoteIP - l'adresse IP de destination pour le tunnel IPsec (dans le site)

  • ikeVersion - indique 1 pour IKEv1 et 2 pour IKEv2

interfaceInfo

Le champ interfaceInfo contient des données relatives aux ports d'un Socket pour un site, configurés dans l'Application de gestion Cato (Configuration > Sites > Socket Configuration). Ce sont les détails des champs :

  • id - ID pour le port du Socket dans l'onglet Surveiller de l'Interface Web du Socket

  • name - nom pour le port dans l'Application de gestion Cato

  • upstreamBandwidth - Bande passante maximale autorisée sur ce port, pour le trafic du site vers le Cloud Cato

  • downstreamBandwidth - Bande passante maximale autorisée pour le trafic sur ce port, du Cloud Cato vers le site