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

event.get

Beschrijving

integer/array event.get(object parameters)

Deze methode maakt het mogelijk om gebeurtenissen op te halen op basis van de opgegeven parameters.

Deze methode kan gebeurtenissen retourneren van een verwijderde entiteit als deze gebeurtenissen nog niet zijn verwijderd door de opruimer.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste output definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
eventids string/array Geef alleen gebeurtenissen terug met de opgegeven ID's.
groupids string/array Geef alleen gebeurtenissen terug die zijn gemaakt door objecten die behoren tot de opgegeven hostgroepen.
hostids string/array Geef alleen gebeurtenissen terug die zijn gemaakt door objecten die behoren tot de opgegeven hosts.
objectids string/array Geef alleen gebeurtenissen terug die zijn gemaakt door de opgegeven objecten.
source integer Geef alleen gebeurtenissen terug met het opgegeven type.

Zie de pagina over gebeurtenisobjecten voor een lijst van ondersteunde gebeurtenistypen.

Standaard: 0 - trigger-gebeurtenissen.
object integer Geef alleen gebeurtenissen terug die zijn gemaakt door objecten van het opgegeven type.

Zie de pagina over gebeurtenisobjecten voor een lijst van ondersteunde objecttypen.

Standaard: 0 - trigger.
acknowledged boolean Als ingesteld op true, geef alleen erkende gebeurtenissen terug.
suppressed boolean true - geef alleen onderdrukte gebeurtenissen terug;
false - geef gebeurtenissen terug in de normale toestand.
symptom boolean true - geef alleen symptoomgebeurtenissen terug;
false - geef alleen oorzaakgebeurtenissen terug.
severities integer/array Geef alleen gebeurtenissen terug met opgegeven gebeurtenisernst. Alleen van toepassing als object een trigger is.
evaltype integer Regels voor tag-zoeken.

Mogelijke waarden:
0 - (standaard) En/Of;
2 - Of.
tags array van objects Geef alleen gebeurtenissen terug met opgegeven tags. Exacte overeenkomst op tag en hoofdletterongevoelige zoekopdracht op waarde en operator.
Formaat: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Een lege array geeft alle gebeurtenissen terug.

Mogelijke operatortypen:
0 - (standaard) Like;
1 - Gelijk;
2 - Niet zoals;
3 - Niet gelijk
4 - Bestaat;
5 - Bestaat niet.
eventid_from string Geef alleen gebeurtenissen terug met ID's groter dan of gelijk aan het opgegeven ID.
eventid_till string Geef alleen gebeurtenissen terug met ID's kleiner dan of gelijk aan het opgegeven ID.
time_from timestamp Geef alleen gebeurtenissen terug die zijn gemaakt na of op het opgegeven tijdstip.
time_till timestamp Geef alleen gebeurtenissen terug die zijn gemaakt voor of op het opgegeven tijdstip.
problem_time_from timestamp Geeft alleen gebeurtenissen terug die in de probleemstatus waren vanaf problem_time_from. Alleen van toepassing als de bron triggergebeurtenis is en het object een trigger is. Verplicht als problem_time_till is gespecificeerd.
problem_time_till timestamp Geeft alleen gebeurtenissen terug die in de probleemstatus waren tot problem_time_till. Alleen van toepassing als de bron triggergebeurtenis is en het object een trigger is. Verplicht als problem_time_from is gespecificeerd.
value integer/array Geef alleen gebeurtenissen terug met de opgegeven waarden.
selectHosts query Geef een hosts eigenschap terug met hosts die het object hebben gemaakt dat de gebeurtenis heeft gemaakt. Alleen ondersteund voor gebeurtenissen gegenereerd door triggers, items of LLD-regels.
selectRelatedObject query Geef een relatedObject eigenschap terug met het object dat de gebeurtenis heeft gemaakt. Het type object dat wordt geretourneerd, is afhankelijk van het gebeurtenistype.
select_alerts query Geef een alerts eigenschap terug met waarschuwingen die zijn gegenereerd door de gebeurtenis. Waarschuwingen zijn gesorteerd in omgekeerde chronologische volgorde.
select_acknowledges query Geef een acknowledges eigenschap terug met gebeurtenisupdates. Gebeurtenisupdates zijn gesorteerd in omgekeerde chronologische volgorde.

Het gebeurtenisupdate-object heeft de volgende eigenschappen:
acknowledgeid - (string) ID van de erkenning;
userid - (string) ID van de gebruiker die de gebeurtenis heeft bijgewerkt;
eventid - (string) ID van de bijgewerkte gebeurtenis;
clock - (timestamp) tijd waarop de gebeurtenis is bijgewerkt;
message - (string) tekst van het bericht;
action - (integer) updateactie die is uitgevoerd, zie event.acknowledge;
old_severity - (integer) gebeurtenisernst voor deze updateactie;
new_severity - (integer) gebeurtenisernst na deze updateactie;
suppress_until - (timestamp) tijd tot de gebeurtenis wordt onderdrukt;
taskid - (string) ID van de taak als de huidige gebeurtenis een rangwijziging ondergaat;
username - (string) gebruikersnaam van de gebruiker die de gebeurtenis heeft bijgewerkt;
name - (string) naam van de gebruiker die de gebeurtenis heeft bijgewerkt;
surname - (string) achternaam van de gebruiker die de gebeurtenis heeft bijgewerkt.

Ondersteunt count.
selectTags query Geef een tags eigenschap terug met gebeurtenistags.
selectSuppressionData query Geef een suppression_data eigenschap terug met de lijst van actieve onderhoudsmodi en handmatige onderdrukkingen:
maintenanceid - (string) ID van het onderhoud;
userid - (string) ID van de gebruiker die de gebeurtenis heeft onderdrukt;
suppress_until - (integer) tijd tot de gebeurtenis wordt onderdrukt.
sortfield string/array Sorteer het resultaat op de opgegeven eigenschappen.

Mogelijke waarden: eventid, objectid, clock.
countOutput boolean Deze parameters die gemeenschappelijk zijn voor alle get-methoden, worden in detail beschreven op de referentiecommentaar pagina.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Retourwaarden

(integer/array) Retourneert ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Opvragen van triggergebeurtenissen

Haal de nieuwste gebeurtenissen op van trigger "13926."

Verzoek:

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

Reactie:

{
           "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",
                   "cause_eventid": "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",
                           "suppress_until": "1472511600",
                           "taskid": "0",
                           "username": "Admin",
                           "name": "Zabbix",
                           "surname": "Administrator"
                       }
                   ],
                   "suppression_data": [
                       {
                           "maintenanceid": "15",
                           "suppress_until": "1472511600",
                           "userid": "0"
                       }
                   ],
                   "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": "Niet beschikbaar via ICMP-ping",
                   "severity": "4",
                   "r_eventid": "0",
                   "c_eventid": "0",
                   "correlationid": "0",
                   "userid": "0",
                   "cause_eventid": "0",
                   "opdata": "",
                   "acknowledges": [],
                   "suppression_data": [],
                   "suppressed": "0",
                   "tags": []
               }
           ],
           "id": 1
       }

Gebeurtenissen opvragen per tijdsperiode

Haal alle gebeurtenissen op die zijn gemaakt tussen 9 en 10 oktober 2012, in omgekeerde chronologische volgorde.

Verzoek:

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

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "eventid": "20616",
                   "source": "0",
                   "object": "0",
                   "objectid": "14282",
                   "clock": "1350477814",
                   "value": "1",
                   "acknowledged": "0",
                   "ns": "0",
                   "name": "Minder dan 25% vrij in de geschiedeniscache",
                   "severity": "3",
                   "r_eventid": "0",
                   "c_eventid": "0",
                   "correlationid": "0",
                   "userid": "0",
                   "cause_eventid": "0",
                   "opdata": "",
                   "suppressed": "0"
               },
               {
                   "eventid": "20617",
                   "source": "0",
                   "object": "0",
                   "objectid": "14283",
                   "clock": "1350477814",
                   "value": "0",
                   "acknowledged": "0",
                   "ns": "0",
                   "name": "Zabbix trapper-processen meer dan 75% bezig",
                   "severity": "3",
                   "r_eventid": "0",
                   "c_eventid": "0",
                   "correlationid": "0",
                   "userid": "0",
                   "cause_eventid": "0",
                   "opdata": "",
                   "suppressed": "0"
               },
               {
                   "eventid": "20618",
                   "source": "0",
                   "object": "0",
                   "objectid": "14284",
                   "clock": "1350477815",
                   "value": "1",
                   "acknowledged": "0",
                   "ns": "0",
                   "name": "Hoge ICMP pingverlies",
                   "severity": "3",
                   "r_eventid": "0",
                   "c_eventid": "0",
                   "correlationid": "0",
                   "userid": "0",
                   "cause_eventid": "0",
                   "opdata": "",
                   "suppressed": "0"
               }
           ],
           "id": 1
       }

Retrieving events acknowledged by specified user

Retrieving events acknowledged by user with ID=10

Request:

{
           "jsonrpc": "2.0",
           "method": "event.get",
           "params": {
               "output": "extend",
               "select_acknowledges": ["userid", "action"],
               "filter": {
                   "action": 2,
                   "action_userid": 10
               },
               "sortfield": ["eventid"],
               "sortorder": "DESC"
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "eventid": "1248566",
                   "source": "0",
                   "object": "0",
                   "objectid": "15142",
                   "clock": "1472457242",
                   "ns": "209442442",
                   "r_eventid": "1245468",
                   "r_clock": "1472457285",
                   "r_ns": "125644870",
                   "correlationid": "0",
                   "userid": "10",
                   "name": "Zabbix agent on localhost is unreachable for 5 minutes",
                   "acknowledged": "1",
                   "severity": "3",
                   "cause_eventid": "0",
                   "opdata": "",
                   "acknowledges": [
                       {
                           "userid": "10",
                           "action": "2"
                       }
                   ],
                   "suppressed": "0"
               }
           ],
           "id": 1
       }

Retrieving top triggers with problem event count

Retrieve the top 5 triggers that have severities "Warning", "Average", "High", or "Disaster", together with the number of problem events within a specified time period.

Request:

{
           "jsonrpc": "2.0",
           "method": "event.get",
           "params": {
               "countOutput": true,
               "groupBy": "objectid",
               "source": 0,
               "object": 0,
               "value": 1,
               "time_from": 1672531200,
               "time_till": 1677628800,
               "trigger_severities": [2, 3, 4, 5],
               "sortfield": ["rowscount"],
               "sortorder": "DESC",
               "limit": 5
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "objectid": "232124",
                   "rowscount": "27"
               },
               {
                   "objectid": "29055",
                   "rowscount": "23"
               },
               {
                   "objectid": "253731",
                   "rowscount": "18"
               },
               {
                   "objectid": "254062",
                   "rowscount": "11"
               },
               {
                   "objectid": "23216",
                   "rowscount": "7"
               }
           ],
           "id": 1
       }

Zie ook

Bron

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