event.get

Opis

integer/array event.get(object parameters)

Metoda pozwala na pobieranie zdarzeń zgodnie z podanymi parametrami.

Ta metoda może zwrócić zdarzenia usuniętego obieku jeśli zdarzenia te nie zostały jeszcze usunięte przez proces usługi czyszczenia historii.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika po więcej informacji.

Parametry

(object) Parametry definiujące żądany wynik.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
eventids string/array Zwraca tylko zdarzenia o podanych identyfikatorach.
groupids string/array Zwraca tylko zdarzenia utworzone przez obiekty należące do podanych grup hostów.
hostids string/array Zwraca tylko zdarzenia utworzone przez obiekty należące do podanych hostów.
objectids string/array Zwraca tylko zdarzenia utworzone przez podane obiekty.
source integer Zwraca tylko zdarzenia o podanym typie.

Przejdź do strony obiektu zdarzenia , aby uzyskać listę obsługiwanych typów zdarzeń.

Domyślnie: 0 - zdarzenia wyzwalacza.
object integer Zwraca tylko zdarzenia utworzone przez obiekty danego typu.

Przejdź na stronę obiektu zdarzenia, aby zapoznać się z listą obsługiwanych typów obiektów.

Domyślnie : 0 - wyzwalacz.
acknowledged boolean Zwraca tylko potwierdzone zdarzenia jeśli jest ustawione na true.
suppressed boolean true - - zwraca tylko zdarzenia wstrzymane;
false - zwraca zdarzenia w normalnym stanie.
severities integer/array Zwraca tylko zdarzenia o określonych poziomach zdarzeń. Ma zastosowanie tylko wtedy, gdy obiekt jest wyzwalaczem.
evaltype integer Reguły wyszukiwania znaczników.

Możliwe wartości:
0 - (domyślnie) I/Lub;
2 - Lub.
tags array of objects Zwraca tylko zdarzenia z podanymi tagami. Zwraca dokładne dopasowanie według znacznika i wyszukiwanie bez rozróżniania wielkości liter według wartości i operatora.
Format: [{"tag": "<znacznik>", "value": "<wartość>", "operator": "<operator> "}, ...].
Pusta tablica zwraca wszystkie zdarzenia.

Możliwe typy operatorów:
0 - (domyślnie) Zawiera;
1 - Jest równy;
2 - Nie zawiera;
3 - Nie jest równy
4 - Istnieje;
5 - Nie istnieje.
eventid_from string Zwraca tylko zdarzenia o identyfikatorach większych lub równych podanemu ID.
eventid_till string Zwraca tylko zdarzenia o identyfikatorach mniejszych lub równych podanemu ID.
time_from timestamp Zwraca tylko zdarzenia, które zostały utworzone po lub w podanym czasie.
time_till timestamp Zwraca tylko zdarzenia, które zostały utworzone przed lub w określonym czasie.
problem_time_from timestamp Zwraca tylko zdarzenia, które były w stanie problem rozpoczynający się od czasu problem_time_from. Ma zastosowanie tylko wtedy, gdy źródłem jest zdarzenie wyzwalacza, a obiekt jest wyzwalaczem. Obowiązkowe, jeśli określono problem_time_till.
problem_time_till timestamp Zwraca tylko zdarzenia, które były w stanie problem do czasu problem_time_till. Ma zastosowanie tylko wtedy, gdy źródłem jest zdarzenie wyzwalacza, a obiekt jest wyzwalaczem. Obowiązkowe, jeśli określono problem_time_from.
value integer/array Zwraca tylko zdarzenia o podanych wartościach.
selectHosts query Zwraca właściwość hosts z hostami zawierającymi obiekt, który utworzył zdarzenie. Obsługiwane tylko dla zdarzeń generowanych przez wyzwalacze, pozycje lub reguły LLD.
selectRelatedObject query Zwraca właściwość relatedObject wraz z obiektem, który utworzył zdarzenie. Typ zwracanego obiektu zależy od typu zdarzenia.
select_alerts query Zwraca właściwość alerts z alarmami wygenerowanymi przez zdarzenie. Alarmy są sortowane w odwrotnej kolejności chronologicznej.
select_acknowledges query Zwraca właściwość acknowledges z aktualizacjami zdarzeń. Aktualizacje zdarzeń są sortowane w odwrotnej kolejności chronologicznej.

Obiekt aktualizacji zdarzeń ma następujące właściwości:
acknowledgeid - (string) ID potwierdzenia;
userid - (string) ID użytkownika, który zaktualizował zdarzenie;
eventid - (string) ID zaktualizowanego zdarzenia;
clock - (timestamp) czas aktualizacji zdarzenia;
message - (string) tekst wiadomości;
action - (integer) akcja aktualizacji, która została wykonana. Zobacz event.acknowledge;
old_severity - (integer) poziom zdarzenia przed aktualizacją zdarzenia;
new_severity - (integer) poziom zdarzenia po aktualizacją zdarzenia;
username - (string) login użytkownika, który zaktualizował zdarzenie;
name - (string) imię użytkownika, który zaktualizował zdarzenie;
surname - (string) nazwisko użytkownika, który zaktualizował zdarzenie.

Obsługuje count.
selectTags query Zwraca właściwość tags z znacznikami zdarzeń.
selectSuppressionData query Zwraca właściwość suppression_data z listą okresów utrzymania:
maintenanceid - (string) ID utrzymania;
suppress_until - (integer) czas dopóki zdarzenie jest wstrzymane.
sortfield string/array Sortuj wynik według podanych właściwości.

Możliwe wartości to: eventid, objectid i clock.
countOutput boolean Te parametry są wspólne dla wszystkich metod get opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobieranie zdarzeń wyzwalacza

Pobierz ostatnie zdarzenia z wyzwalacza „13926”.

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "event.get",
           "params": {
               "output": "extend",
               "select_acknowledges": "extend",
               "selectTags": "extend",
               "selectSuppressionData": "extend",
               "objectids": "13926",
               "sortfield": ["clock", "eventid"],
               "sortorder": "DESC"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "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",
                   "opdata": "",
                   "acknowledges": [
                       {
                           "acknowledgeid": "1",
                           "userid": "1",
                           "eventid": "9695",
                           "clock": "1350640590",
                           "message": "Problem resolved.\n\r----[BULK ACKNOWLEDGE]----",
                           "action": "6",
                           "old_severity": "0",
                           "new_severity": "0",
                           "username": "Admin",
                           "name": "Zabbix",
                           "surname": "Administrator"
                       }
                   ],
                   "suppression_data": [
                       {
                           "maintenanceid": "15",
                           "suppress_until": "1472511600"
                       }
                   ],
                   "suppressed": "1",
                   "tags": [
                       {
                           "tag": "service",
                           "value": "mysqld"
                       },
                       {
                           "tag": "error",
                           "value": ""
                       }
                   ]
               },
               {
                   "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",
                   "opdata": "",
                   "acknowledges": [],
                   "suppression_data": [],
                   "suppressed": "0",
                   "tags": []
               }
           ],
           "id": 1
       }

Pobieranie zdarzeń według okresu

Pobierz wszystkie wydarzenia, które zostały utworzone między 9 a 10 października, 2012, w odwrotnej kolejności chronologicznej.

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "event.get",
           "params": {
               "output": "extend",
               "time_from": "1349797228",
               "time_till": "1350661228",
               "sortfield": ["clock", "eventid"],
               "sortorder": "desc"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Odpowiedź:

{
           "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",
                   "opdata": "",
                   "suppressed": "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",
                   "opdata": "",
                   "suppressed": "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",
                   "opdata": "",
                   "suppressed": "0"
               }
           ],
           "id": 1
       }

Zobacz także

Źródło

CEvent::get() w ui/include/classes/api/services/CEvent.php.