Cato Read Only API - appStats – Base de connaissances

Vue d'ensemble des appStats

L'API appStats est basée sur l'écran d'Analytics des applications et fournit des données réseau agrégées sur une période de temps par source, destination, application, etc.

Chaque requête calcule l'agrégation sur différentes mesures (octets envoyés, octets reçus, nombre de flux, etc.) en fonction d'une fonction d'agrégation donnée (somme, max, moyenne, etc.) et différentes dimensions (nom_du_site, utilisateur, application, etc.)

Exemples d'utilisation de la requête appStats:

Calculer le total/la moyenne/le maximum de la bande passante d'un site spécifique
Nombre maximal de flux générés vers une destination spécifique
Top 10 des applications utilisées par un certain hôte donné

Arguments pour appStats

Ce sont les arguments que vous pouvez transmettre et définir les données qui sont retournées par la requête (tous les champs sont obligatoires) :

identifiantsDeCompte
mesures
filtres
dimension
trier
période

Argument identifiantDeCompte appStats

Entrez un ou plusieurs identifiants de compte pour les données que la requête renvoie.

Cet identifiant de compte n'est pas affiché dans l'Application de gestion Cato, il s'agit plutôt du numéro dans l'URL pour l'Application de gestion Cato. Par exemple, l'identifiant de compte est 26 pour l'URL suivante : https://cc.catonetworks.com/#!/26/topology.

Argument filtres appStats

L'argument filtres vous permet de définir les données spécifiques qui sont incluses dans la requête. Ce sont les arguments que vous pouvez définir :

nomDuChamp - définit le type de champ que vous souhaitez filtrer (pour plus d'informations, voir Champs appStats)
opérateur - définit comment activer les valeurs pour filtrer les données (pour plus d'informations, voir opérateurDeFiltre appStats)
valeurs - définit la valeur de filtre utilisée avec l'opérateur

La syntaxe suivante filtres est un exemple de requête filtrée pour afficher les données d'une application spécifique :

"filtres": [
    {
        "nomDuChamp": "application",
        "opérateur": "est",
        "valeurs": [
            "Slack"
        ]
    }
]

Argument dimensions appStats

Utilisez l'argument dimensions pour regrouper les champs ayant les mêmes valeurs en lignes de résumé.

L'exemple suivant regroupe les champs en fonction des noms de site :

"dimensions": [
    {
        "nomDuChamp": "nom_du_site"
    }
]

Argument mesures appStats

L'argument mesures vous permet de définir les champs que vous souhaitez que la requête renvoie et leur type d'agrégation. Ce sont les arguments que vous pouvez définir :

nomDuChamp - définit le type de champ que vous souhaitez filtrer (pour plus d'informations, voir Champs appStats)
typeAggr - définit le type d'agrégation (pour plus d'informations, voir Agrégation appStats)

L'exemple suivant montre la syntaxe mesures pour une requête mesurant le résumé des flux créés pour l'application Slack :

"filtres": [
    {
        "nomDuChamp": "application",
        "opérateur": "est",
        "valeurs": [
            "Slack"
        ]
    }
]
"mesures": [
    {
        "nomDuChamp": "flux_créés",
        "typeAggr": "som"
    }
]

Argument trier appStats

L'argument trier définit comment les données sont triées.

L'exemple suivant montre la syntaxe trier pour une requête mesurant le résumé des flux créés pour l'application Slack. Il trie ensuite les données dans un ordre décroissant des flux créés :

"filtres": [
    {
        "nomDuChamp": "application",
        "opérateur": "est",
        "valeurs": [
            "Slack"
        ]
    }
]
"mesures": [
    {
        "nomDuChamp": "flux_créés",
        "typeAggr": "som"
    }
]
"trier": [
    {
        "nomDuChamp": "flux_créés",
        "ordre": "dec"
    }
]

Argument période appStats

Définit la période de la requête.

"période": "dernière.P2J"

Exemple de requête appStats

C'est un exemple d'utilisation de la requête API appStats pour retourner la somme des flux créés pour l'application Slack pour chaque site sur la période des deux derniers jours. Les données sont triées par ordre décroissant pour les cinq principaux sites.

Exemple de Requête

query appStats($accountID: ID!, $measures: [Measure], $dimensions: [Dimension], $filters: [AppStatsFilter!], $sort: [AppStatsSort!], $timeFrame: TimeFrame!, $limit: Int, $from: Int) {
  appStats(
    accountID: $accountID
    timeFrame: $timeFrame
    measures: $measures
    dimensions: $dimensions
    filters: $filters
    sort: $sort
  ) {
    id
    records(limit: $limit, from: $from) {
      fieldsUnitTypes
      fieldsMap
      trends
    }
  }
}

Valeurs des Variables

{
  "accountID": "1234",
  "dimensions": [
    {
      "nomDuChamp": "nom_du_site"
    }
  ],
  "measures": [
    {
      "nomDuChamp": "flux_créés",
      "typeAggr": "som"
    }
  ],
  "filtres": [
    {
        "nomDuChamp": "application",
        "opérateur": "est",
        "valeurs": [
            "Slack"
        ]
    }
]
  "trier": [
    {
      "nomDuChamp": "flux_créés",
      "ordre": "dec"
    }
  ],
  "période": "dernière.P2J",
  "limite": 5,
  "origine": 0
}

Exemple de Sortie des appStats

{
   "données": {
     "appStats": {
       "id": "1234",
       "enregistrements": [
         {
           "fieldsMap": {
             "flux_créés": "116660",
             "nom_du_site": "Exemple de Socket"
           }
         },
         {
           "fieldsMap": {
             "flux_créés": "105655",
             "nom_du_site": "Exemple de Socket 2"
           }
         }
       ]
     }
   }
}

Champs appStats

Ceci est une description des champs dans les requêtes appStats.

Élément	Description
application	nom de l'application cloud
nouvelle_app	nouvel identifiant d'application cloud
appli_découverte	nombre total d'applications utilisées
trafic	la somme totale des données uploadées et téléchargées en octets
amont	données téléchargées vers les applications cloud
aval	données téléchargées depuis les applications cloud
score_de_risque	le score de risque de l'application attribué par Cato
niveau_de_risque	le niveau de risque de l'application
sanctionné	applications cloud approuvées pour être utilisées et gérées par l'organisation
lieu_qg	le pays où le siège social de l'application est situé
est_app_cloud	indique si l'application est considérée comme une application cloud/SaaS
catégorie	la catégorie de l'application cloud
description	description de la catégorie
ip	IP de l'hôte ou du client SDP
sous-réseau	nom du sous-réseau
domaine	SSL SNI, nom d'hôte HTTP, nom DNS ou IP de destination
ip_dest	adresse IP du serveur (uniquement pertinent pour les connexions WAN)
id_du_site_src	ID interne unique de Cato pour le site
nom_du_site_src	site source ou utilisateur SDP
pays_du_site	pays où le site est situé
état_du_site	état où le site est situé
id_utilisateur_vpn	ID interne unique de Cato pour l'utilisateur SDP
flux_créés	Nombre de connexions créées
site_dest	ID de site de destination ou ID utilisateur SDP (protocole)
est_site_ou_vpn_dest	site destination ou utilisateur SDP
id_site_dest	ID de site de destination ou utilisateur SDP (base de données)
nom_du_site_dest	site de destination ou nom d'utilisateur SDP
sens_du_trafic	sens du trafic
nom_de_l'appareil	Nom du PC ou de l'appareil
nom_ad	Nom Active Directory
src_ip	Adresse IP pour l'hôte ou le Client SDP
interface_socket	Nom de l'interface Socket
src_est_site_ou_vpn	le trafic est site ou Client SDP

Agrégation appStats

Ce sont les valeurs pour le Type d'agrégation appStats aggType :

somme
compte
compte_distinct
distinct
moyenne
max
min
n'importe quel

opérateur_filtre appStats

Ce sont les valeurs pour l'opérateur_filtre appStats :

est
n'est_pas
dans
pas_dans
existe
n'existe_pas
entre
pas_entre
gt
gte
lt
lte

Cato Read Only API - appStats