V2 - Les propriétés présentes dans le retour 200 des API du broker-module-livedata

Sommaire

Liste des propriétés disponibles

Les données statistiques sont systématiquement retournées dans le résultat, quand la requête s'effectue sans erreur (code de statut 200)

Nom	Type	Description
nb_elements_total	Entier	Nombre d'éléments supervisés visibles par l'utilisateur
nb_hosts_total	Entier	Nombre total d'hôtes visibles par l'utilisateur
nb_clusters_total	Entier	Nombre total de clusters visibles par l'utilisateur
nb_checks_total	Entier	Nombre total de checks visibles par l'utilisateur

Nom	Type	Description
nb_elements_filtered	Entier	Nombre d'éléments supervisés obtenus après application des filtres reçus en paramètres
nb_hosts_filtered	Entier	Nombre d'hôtes obtenus après application des filtres reçus en paramètres
nb_clusters_filtered	Entier	Nombre de clusters obtenus après application des filtres reçus en paramètres
nb_checks_filtered	Entier	Nombre de checks obtenus après application des filtres reçus en paramètres

Nom

Type

Description

nb_elements_not_found

Entier

Nombre d'éléments dont un filtre explicite (voir ci dessous) ne donne pas le retour attendu

nb_fathers_not_found

Entier

Nombre d'hôtes et de clusters pour lesquels un filtre father_name ou father_uuid ne donne pas d'élément en résultat

nb_checks_not_found

Entier

Nombre de checks pour lesquels un des filtres

ne donne pas d'élément en résultat

Les propriétés ci-dessous, également utilisables pour les filtres peuvent être utilisées pour être affichées dans le résultat de la requête.

Nom	Sortie	Valeurs possibles	Exemple d’expression
status	1 valeur	0 pour OK, 1 pour ATTENTION, 2 pour CRITIQUE, 3 pour INCONNU	0
context	1 valeur	NOTHING, ACKNOWLEDGED, ACKNOWLEDGED, PARTIAL-ACKNOWLEDGED, INHERITED-ACKNOWLEDGED, DOWNTIME, PARTIAL-DOWNTIME, INHERITED-DOWNTIME, FLAPPING, PARTIAL-FLAPPING, DISABLED	"FLAPPING"
is_status_confirmed	1 valeur	true / false	true
type	1 valeur	HOST, CLUSTER, CHECK_HOST, CHECK_CLUSTER	"check_host"
father_name	1 valeur		"bordeaux-storage"
check_name	1 valeur		"CPU Stats"
description	1 valeur		"Bordeaux"
address	1 valeur		"192.168.1.20"
realm	1 valeur		"Paris"
notification_contacts	valeurs séparées par des virgules	Noms des contacts	[ "user1", "user2" ]
notification_contact_groups	valeurs séparées par des virgules	Noms des groupes de contacts	[ "groupe1", "groupe2" ]
father_templates	valeurs séparées par des virgules	Noms des modèles d'hôtes	[ "linux", "http" ]
host_groups	valeurs séparées par des virgules	Noms des groupes d'hôtes	[ "ERP_bordeaux", "Aquitaine" ]
business_impact	1 valeur	0 pour , 1 pour , 2 pour ****, 3 pour $, 4 pour $$, 5 pour $$$**	4
status_since	1 valeur	epoch ( en secondes )	1606155095
status_confirmed_since	1 valeur	epoch ( en secondes ) (0 si état non confirmé)	1606155095
last_check	1 valeur	epoch ( en secondes )	1606991424
next_check	1 valeur	epoch ( en secondes )	1606991444

Les propriétés ci-dessous peuvent être utilisées pour être affichées dans le résultat de la requête.

Nom	Sortie	Valeur possible	Exemple d’expression
attempts	1 valeur	entier	2
max_attempts	1 valeur	entier	2
output	1 valeur	texte	"PING OK - Packet loss = 0%, RTA = 0.01 ms"
long_output	1 valeur	texte	"<div class=\"skn-ich\">Module info:</div><br/><div class=\"skn-tbl-57069\">Some DATA</div>"
perf_data	1 valeur	tableau JSON	[ { "name": "rta", "min": 0, "max": null, "value": 0.013, "warning": 1000, "critical": 3000, "uom": "ms" }, { "name": "pl", "min": 0, "max": 100, "value": 0, "warning": 100, "critical": 100, "uom": "%" } ]
raw_perf_data	1 valeur	texte	"rta=0.013000ms;1000.000000;3000.000000;0.000000 pl=0%;100;100;0"
notes_url	1 valeur	texte	"http://localhost/"
notes_multi_url	1 valeur	texte	"UI_Configuration~=http://localhost:7766~=write~=NO~#~UI_Visualisation~=http://localhost:7767~=stats~=OPEN_IN_NEW_TAB"
notification_options	1 valeur	tableau JSON	[ "w", "u", "c", "r", "f" ]
notification_period	1 valeur	texte	"24x7"