Sidebar
fr:manual:api:reference:event:get
Table of Contents
event.get
Description
integer/array event.get(object parameters)
La méthode permet de récupérer des événements en fonction des paramètres donnés.
Paramètres
(object) Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| eventids | string/array | Renvoie uniquement les événements avec les identifiants donnés. |
| groupids | string/array | Renvoie uniquement les événements créés par des objets appartenant aux groupes d'hôtes donnés. |
| hostids | string/array | Renvoie uniquement les événements créés par des objets appartenant aux hôtes donnés. |
| objectids | string/array | Renvoie uniquement les événements créés par les objets donnés. |
| applicationids | string/array | Renvoie uniquement les événements créés par des objets appartenant aux applications données. S'applique uniquement si l'objet est un déclencheur ou un élément. |
| source | integer | Renvoie uniquement les événements avec le type donné. Se référer à la page de l'objet Événement pour une liste des types d'événements supportés. Par défaut : 0 - événements de déclencheur. |
| object | integer | Renvoie uniquement les événements créés par des objets du type donné. Se référer à la page de l'objet Événement pour une liste des types d'événements supportés. Par défaut : 0 - déclencheur. |
| acknowledged | boolean | Si défini à true, ne renvoie que les événements acquittés. |
| suppressed | boolean | true - Renvoie uniquement les événements supprimés ; false - Renvoie uniquement les événements supprimés dont l'état est normal. |
| severities | integer/array | Renvoie uniquement les événements avec des sévérités données. S'applique uniquement si l'objet est déclencheur. |
| evaltype | integer | Règles pour la recherche de tags. Valeurs possibles : 0 - (par défaut) et/ou ; 2 - ou. |
| tags | array of object | Renvoie uniquement les événements avec des tags donnés. Correspondance exacte par tag et recherche non sensible à la casse par valeur et opérateur. Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Un tableau vide renvoie tous les événements. Types d'opérateurs possibles : 0 - (par défaut) comme ; 1 - égal. |
| eventid_from | string | Renvoie uniquement les événements dont l'identifiant est supérieur ou égal à l'identifiant donné. |
| eventid_till | string | Renvoie uniquement les événements dont l'identifiant est inférieur ou égal à l'identifiant donné. |
| time_from | timestamp | Renvoie uniquement les événements créés après ou à l'heure indiquée. |
| time_till | timestamp | Renvoie uniquement les événements créés avant ou à l'heure indiquée. |
| problem_time_from | timestamp | Renvoie uniquement les événements qui étaient en état problème depuis problem_time_from. S'applique uniquement si la source est un événement de déclencheur et que l'objet est un déclencheur. Obligatoire si problem_time_till est spécifié. |
| problem_time_till | timestamp | Renvoie uniquement les événements qui étaient en état problème jusqu'àproblem_time_till. S'applique uniquement si la source est un événement de déclencheur et que l'objet est un déclencheur. Obligatoire si problem_time_from est spécifié. |
| value | integer/array | Renvoie uniquement les événements avec les valeurs données. |
| selectHosts | query | Renvoie les hôtes contenant l'objet qui a créé l'événement dans la propriété hosts. Pris en charge uniquement pour les événements générés par des déclencheurs, des éléments ou des règles de découverte bas niveau. |
| selectRelatedObject | query | Renvoie l'objet qui a créé l'événement dans la propriété relatedObject. Le type d'objet renvoyé dépend du type d'événement. |
| select_alerts | query | Renvoie les alertes générées par l'événement dans la propriété alerts. Les alertes sont triées dans l'ordre chronologique inverse. |
| select_acknowledges | query | Renvoie les mises à jour de l'événement dans la propriété acknowledges. Les mises à jour d'événements sont triées dans l'ordre chronologique inverse. L'objet de mise à jour d'événement a les propriétés suivantes : acknowledgeid - (string) ID de l'acquittement ; userid - (string) ID de l'utilisateur qui a mis à jour l'événement ; eventid - (string) ID de l'événement mis à jour ; clock - (timestamp) heure de mise à jour de l'événement ; message - (string) texte du message ; action - (integer) action de mise à jour effectuée, voir event.acknowledge ; old_severity - (integer) sévérité de l'événement avant cette action de mise à jour ; new_severity - (integer) sévérité de l'événement après cette action de mise à jour ; alias - (string) alias de l'utilisateur qui a mis à jour l'événement ; name - (string) nom de l'utilisateur qui a mis à jour l'événement ; surname - (string) nom de famille de l'utilisateur qui a mis à jour l'événement. Supporte count. |
| selectTags | query | Renvoie les tags d'événement dans la propriété tags. |
| selectSuppressionData | query | Renvoie une liste de maintenances dans la propriété suppression_data : maintenanceid - (string) ID de la maintenance ; suppress_until - (integer) temps avant que l'événement soit supprimé. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : eventid, objectid et clock. |
| countOutput | boolean | Ces paramètres, communs à toutes les méthodes “get”, sont décrits dans les commentaires de référence. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
Valeurs retournées
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupération d'événements de déclencheur
Récupérer les derniers événements du déclencheur “13926”.
Requête :
{ "jsonrpc": "2.0", "method": "event.get", "params": { "output": "extend", "select_acknowledges": "extend", "selectTags": "extend", "objectids": "13926", "sortfield": ["clock", "eventid"], "sortorder": "DESC" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Réponse :
{ "jsonrpc": "2.0", "result": [ { "acknowledges": [ { "acknowledgeid": "1", "userid": "1", "eventid": "9695", "clock": "1350640590", "message": "Problem resolved.\n\r----[BULK ACKNOWLEDGE]----", "action": "6", "old_severity": "0", "new_severity": "0", "alias": "Admin", "name": "Zabbix", "surname": "Administrator" } ], "eventid": "9695", "source": "0", "object": "0", "objectid": "13926", "clock": "1347970410", "value": "1", "acknowledged": "1", "ns": "413316245", "name": "MySQL is down", "severity": "5", "r_eventid": "0", "c_eventid": "0", "correlationid": "0", "userid": "0", "tags": [ { "tag": "service", "value": "mysqld" }, { "tag": "error", "value": "" } ], "suppression_data": [ { "maintenanceid": "15", "suppress_until": "1472511600" } ] }, { "acknowledges": [], "eventid": "9671", "source": "0", "object": "0", "objectid": "13926", "clock": "1347970347", "value": "0", "acknowledged": "0", "ns": "0", "name": "Unavailable by ICMP ping", "severity": "4", "r_eventid": "0", "c_eventid": "0", "correlationid": "0", "userid": "0", "tags": [], "suppression_data": [] } ], "id": 1 }
Récupération d'événements par période de temps
Récupérer tous les événements créés entre le 9 et le 10 octobre 2012, dans l'ordre chronologique inverse.
Requête :
{ "jsonrpc": "2.0", "method": "event.get", "params": { "output": "extend", "time_from": "1349797228", "time_till": "1350661228", "sortfield": ["clock", "eventid"], "sortorder": "desc" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Réponse :
{ "jsonrpc": "2.0", "result": [ { "eventid": "20616", "source": "0", "object": "0", "objectid": "14282", "clock": "1350477814", "value": "1", "acknowledged": "0", "ns": "0", "name": "Less than 25% free in the history cache", "severity": "3", "r_eventid": "0", "c_eventid": "0", "correlationid": "0", "userid": "0" }, { "eventid": "20617", "source": "0", "object": "0", "objectid": "14283", "clock": "1350477814", "value": "0", "acknowledged": "0", "ns": "0", "name": "Zabbix trapper processes more than 75% busy", "severity": "3", "r_eventid": "0", "c_eventid": "0", "correlationid": "0", "userid": "0" }, { "eventid": "20618", "source": "0", "object": "0", "objectid": "14284", "clock": "1350477815", "value": "1", "acknowledged": "0", "ns": "0", "name": "High ICMP ping loss", "severity": "3", "r_eventid": "0", "c_eventid": "0", "correlationid": "0", "userid": "0" } ], "id": 1 }
Voir également
Source
CEvent::get() dans frontends/php/include/classes/api/services/CEvent.php.