Nous recommandons fortement qu'avant de commencer à utiliser l'API Cato, vous consultiez la politique de support pour l'API Cato.
Vue d'ensemble de auditFeed
La requête auditFeed vous aide à analyser les actions effectuées par les administrateurs dans l'application de gestion Cato. Les données que cette requête retourne sont similaires à la fenêtre Système> Suivi d'Audit dans l'application de gestion Cato.
Pour les comptes revendeurs, vous pouvez créer des clés API distinctes dans chaque compte client auquel vous vous connectez à l'API Cato. Pour plus d'informations sur la limitation de taux et la requête API auditFeed, veuillez consulter Comprendre la Limitation de Taux de l'API Cato.
Comprendre les Données Récupérées
L'appel API auditFeed est conçu pour supporter l'extraction de plus de 2M articles de données d'audit par heure. Pour aider à paginer les données retournées, lorsqu'il y a plus de 1000 articles d'audit sur la durée du cadre de temps, la requête itère le fetch jusqu'à ce qu'elle retourne toutes les données d'audit.
Ces champs sont liés à la pagination des données d'audit : marqueur, fetchedCount, et hasMore. Voir ci-dessous pour les explications de ces champs.
Détails des Champs auditFeed
Ce sont les détails que les champs auditFeed peuvent montrer pour la requête :
de - heure de début
à - heure de fin
marqueur - Le champ marqueur est un identifiant unique pour le dernier article de données d'audit que la requête API a retourné.
fetchedCount - nombre d'articles récupérés (maximum 1000 articles par extraction)
hasMore - lorsque vrai, indique qu'il y a plus d'articles pour la requête à extraire
comptes (auditFeedAccountRecords) - Pour les revendeurs qui gèrent plusieurs comptes, ce champ spécifie le compte qui a été modifié et inclut tous les enregistrements et données d'audit (tableau avec requêtes et champs imbriqués)
auditFeed De
Le champ De montre l'heure de début pour les données de la requête et est défini dans l'argument timeFrame.
auditFeed À
Le champ À montre l'heure de fin pour les données de la requête et est défini dans l'argument timeFrame.
auditFeed Marqueur
Quand il y a plus de 1000 articles de données d'audit durant la durée de la requête, le champ Marqueur montre un identifiant qui indique le début d'une nouvelle itération pour extraire les articles. Par exemple, si la requête retourne 2500 articles, alors voici les résultats sur les itérations d'extraction :
première itération - fetchedCount = 1000 (articles), marqueur = 1234abc, hasMore = true
deuxième itération - fetchedCount = 1000 (articles), marqueur = 4567def, hasMore = true
troisième itération - fetchedCount = 500 (articles), marqueur = 8901xyz, hasMore = false
Vous pouvez ignorer la valeur du marqueur à la dernière itération
auditFeed fetchedCount
Les champs fetchedCount montrent le nombre total d'articles dans l'action de récupération actuelle. La valeur maximale pour ce champ est de 1000.
auditFeed hasMore
Quand la valeur pour le champ hasMore est vraie, alors il y a une autre itération de récupération d'articles après celle-ci.
auditFeed Comptes
Les champs Comptes (auditFeedAccountRecords) montrent les IDs des administrateurs et les données d'audit pour cette requête. Utilisez l'argument auditFeedAccountsRecords > AuditRecord > AuditFieldName pour filtrer les données d'événement qui sont affichées pour la requête. Pour plus d'informations sur les champs AuditRecords, voir ci-dessous auditFeed > fieldName > AuditFieldName.
Arguments pour le auditFeed
Ce sont les arguments que vous pouvez passer et définir les données qui sont retournées par la requête :
accountIDs - identifiants de compte (pour plusieurs comptes, entrez les identifiants sous forme de tableau)
ids - ID de compte (argument hérité)
timeFrame - heure de début et de fin de la requête
filters (AuditFieldFilterInput) - filtrer les données du journal d'audit qui sont interrogées (tableau avec requêtes imbriquées)
marqueur - afficher uniquement les articles pour une itération d'extraction spécifique selon la valeur du marqueur
auditFeed accountIDs Argument
Entrez un ou plusieurs IDs de compte pour les données que la requête retourne. Cet argument est obligatoire.
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 de l'Application de gestion Cato. Par exemple, l'identifiant de compte est 26 pour l'URL suivante : https://cc2.catonetworks.com/#!/26/topology.
Argument de timeFrame auditFeed
Entrez le cadre de temps pour les données que la requête retourne. L'argument est au format <type>.<time value>. Cet argument est obligatoire.
Ce sont les options supportées pour définir le cadre de temps :
dernier.<durée du temps> - La valeur <durée du temps> pour le type
dernierest selon ISO-8601 et retourne les données pour les temps spécifiques précédents. Par exemple:timeFrame =
dernier.PT5Mmontre les 5 dernières minutestimeFrame =
dernier.PT2Hmontre les 2 dernières heurestimeFrame =
dernier.P1Dmontre le dernier jourtimeFrame =
dernier.P3Mmontre les 3 derniers moistimeFrame =
dernier.P1Ymontre la dernière année
<fuseau horaire>.<spécification de cadre-temps-court> - Le cadre de temps combine une date de début et de fin au format YY-MM-DD/hh:mm:ss selon le fuseau horaire spécifié. Par exemple, timeFrame =
utc.2020-02-{11/04:50:00--21/04:50:00}montre les données analytiques du 11 février 2020 4:50:00 au 21 février 2020 4:50:00.
Argument de filtres auditFeed
L'argument filters (AuditFieldFilterInput) vous permet de définir les articles spécifiques qui sont inclus dans la requête de suivi d'audit. Ce sont les arguments que vous pouvez définir :
fieldName > AuditFieldName - définir les articles du Suivi d'Audit
opérateur - définir comment activer les valeurs pour filtrer les données d'audit
valeurs - définir la valeur de filtre utilisée avec l'opérateur
auditFeed > fieldName > AuditFieldName
Ce sont les noms des champs pour les différents types de configurations de l'application de gestion Cato surveillées dans Système > Suivi d'Audit.
admin - l'administrateur dont l'action a généré l'enregistrement
nom_du_modèle - le nom de l'objet qui a été affecté, par exemple Mon Site
admin_id - l'ID de l'administrateur dont l'action a généré l'enregistrement
module - module système qui a été modifié, par exemple Configuration MFA, ou Inspection TLS
date_d'insertion - heure à laquelle le changement a été effectué ou sauvegardé
type_de_changement - décrit le changement effectué par l'administrateur, les valeurs sont : CRÉÉ, SUPPRIMÉ, MODIFIÉ, ACTIVÉ, DÉSACTIVÉ, IGNORÉ
date_de_création - heure à laquelle le changement a été commencé
changement - un compte détaillé du changement en format JSON
type_de_modèle - le type d'objet qui a été modifié, par exemple Site, Socket, InterfaceSocket
Argument de marqueur auditFeed
L'argument marqueur vous permet de limiter la requête aux événements pour une itération spécifique de récupération. Pour afficher les valeurs de marqueur, exécutez la requête avec l'argument marqueur avec une valeur vide. La requête retourne les valeurs de marqueur pour l'argument timeFrame défini.
Par exemple, si la requête retourne 2500 événements, alors voici les résultats sur les trois premières itérations de récupération :
première itération - fetchedCount = 1000 (événements), marqueur = 1234abc, hasMore = true
deuxième itération - fetchedCount = 1000 (événements), marqueur = 4567def, hasMore = true
troisième itération - fetchedCount = 1000 (événements), marqueur = 8901xyz, hasMore = true
Pour afficher uniquement les événements de la deuxième itération, définissez l'argument du marqueur sur 4567def.