This is a translation of the original English documentation page. Help us make it better.

Sidebar

> Objet Corrélation

Les objets suivants sont directement liés à l'API correlation.

Corrélation

L'objet corrélation a les propriétés suivantes.

Propriété Type Description
correlationid string (lecture seule) ID de la corrélation.
name
(obligatoire)
string Nom de la corrélation.
description string Description de la corrélation.
status integer Indique si la corrélation est activée ou désactivée.

Valeurs possibles :
0 - (par défaut) activée ;
1 - désactivée.

Opération de Corrélation

L'objet opération de corrélation définit une opération qui sera effectuée lorsqu'une corrélation est exécutée. Il a les propriétés suivantes.

Propriété Type Description
type
(obligatoire)
integer Type d'opération.

Valeurs possibles :
0 - fermer les anciens évènements ;
1 - fermer le nouvel évènement.

Filtre de Corrélation

L'objet filtre de corrélation définit un ensemble de conditions à respecter pour effectuer les opérations de corrélation configurées. Il a les propriétés suivantes.

Propriété Type Description
evaltype
(obligatoire)
integer Méthode d'évaluation de la condition du filtre.

Valeurs possibles :
0 - et/ou ;
1 - et ;
2 - ou ;
3 - expression personnalisée.
conditions
(obligatoire)
array Ensemble de conditions de filtre à utiliser pour filtrer les résultats.
eval_formula string (lecture seule) Expression générée qui sera utilisée pour évaluer les conditions de filtrage. L'expression contient des ID qui référencent des conditions de filtrage spécifiques par son formulaid. La valeur de eval_formula est égale à la valeur de formula pour les filtres avec une expression personnalisée.
formula string Expression définie par l'utilisateur à utiliser pour évaluer les conditions des filtres avec une expression personnalisée. L'expression doit contenir des IDs qui référencent des conditions de filtrage spécifiques par son formulaid. Les ID utilisés dans l'expression doivent correspondre exactement à ceux définis dans les conditions de filtrage : aucune condition ne peut rester inutilisée ou omise.

Obligatoire pour les filtres d'expression personnalisés.

Condition du filtre de corrélation

L'objet de condition de filtre de corrélation définit une condition spécifique qui doit être vérifiée avant d'exécuter les opérations de corrélation.

Propriété Type Description
type
(obligatoire)
integer Type de condition.

Valeurs possibles :
0 - ancien tag d'événement ;
1 - nouveau tag d'événement ;
2 - nouveau groupe d'hôtes de l'événement ;
3 - paire de tag d'événement ;
4 - ancienne valeur de tag d'événement ;
5 - nouvelle valeur de tag d'événement.
tag string Tag d'événement (ancienne ou nouvelle). Requis lorsque le type de condition est : 0, 1, 4, 5.
groupid string ID du groupe d'hôtes. Requis lorsque le type de condition est : 2.
oldtag string Ancien tag d'événement. Requis lorsque le type de condition est : 3.
newtag string Nouveau tag d'événement. Requis lorsque le type de condition est : 3.
value string Valeur du tag d'événement (ancien ou nouveau). Requis lorsque le type de condition est : 4, 5.
formulaid string ID unique arbitraire utilisé pour référencer la condition à partir d'une expression personnalisée. Ne peut contenir que des lettres majuscules. L'ID doit être défini par l'utilisateur lors de la modification des conditions de filtrage, mais sera généré de nouveau lors d'une demande ultérieure.
operator integer Opérateur de condition.

Requis lorsque le type de condition est : 2, 4, 5.

Pour mieux comprendre comment utiliser des filtres avec différents types d’expressions, voir des exemples sur les pages des méthodes correlation.get et correlation.create.

Les opérateurs et les valeurs suivants sont pris en charge pour chaque type de condition.

Condition Nom de la Condition Opérateurs pris en charge Valeur attendue
2 Groupe d'hôtes =, <> Host group ID.
4 Ancienne valeur de tag d'événement =, <>, like, not like string
5 Nouvelle valeur de tag d'événement =, <>, like, not like string