Documentation Index

Fetch the complete documentation index at: https://knowledge.catonetworks.com/llms.txt

Use this file to discover all available pages before exploring further.

Cato API - AccountMetrics > Sites

Prev Next

AccountMetrics > Sites

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

Champs SiteMetrics

Le champ SiteMetrics contient des données pour les sites et leurs liens. Utilisez l'argument IDs pour spécifier quels sites sont inclus dans la requête.

Voici les détails des champs SiteMetrics pour une requête :

  • id - ID de site ou d'utilisateur VPN ou tableau d'ID

  • interfaceMetric - analyses qui sont retournées pour les liens d'un site (tableau avec requêtes et champs imbriqués)

  • metrics - métriques de trafic et données pour les sites (tableau avec champs imbriqués)

  • name - noms des sites

  • SiteInfo - montre des informations générales sur le site (tableau avec champs imbriqués)

ID

Montre l'ID interne unique pour le site ou l'utilisateur VPN.

Interfaces

Le champ InterfaceMetrics montre les données de lien pour un site. Pour plus d'informations sur InterfaceMetrics, consultez Cato API - AccountMetrics > Sites > Interfaces.

Metrics (Site)

Le champ SiteMetrics montre les analyses de trafic pour le site. Voici les données du site que vous pouvez voir :

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

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

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

  • bytesUpstream - trafic ascendant total (du site vers le Cloud Cato)

  • bytesTotal - trafic total pour le site

  • lostDownstream - nombre de paquets perdus pour le trafic descendant

  • lostDownstreamPcnt - pourcentage de perte de paquets pour le trafic descendant

  • lostUpstream - nombre de paquets perdus pour le trafic montant

  • lostUpstreamPcnt - pourcentage de perte de paquets pour le trafic ascendant

  • 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 aller-retour du site au 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

Nom du site ou de l'utilisateur VPN dans l'application de gestion Cato.

Informations

Les champs SiteInfo montrent des données sur les sites similaires à la fenêtre Site > Général dans l'application de gestion Cato. Pour plus d'informations sur SiteInfo, consultez Cato API - AccountMetrics > Sites > SiteInfo.

Argument siteIDs de SiteMetrics

Entrez les IDs de site et d'utilisateurs VPN pour les données que la requête retourne. Si vous laissez l'argument siteIDs vide, la requête retourne tous les sites et utilisateurs VPN dans le compte.

L'argument ids est un argument hérité et n'est plus nécessaire.