event.get

Beschreibung

integer/array event.get(object parameters)

Mit dieser Methode können Ereignisse entsprechend den angegebenen Parametern abgerufen werden.

Diese Methode kann Ereignisse einer gelöschten Entität zurückgeben, wenn diese Ereignisse noch nicht vom Housekeeper entfernt wurden.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter User roles.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
eventids ID/array Nur Ereignisse mit den angegebenen IDs zurückgeben.
groupids ID/array Nur Ereignisse zurückgeben, die von Objekten erstellt wurden, die zu den angegebenen Host-Gruppen gehören.
hostids ID/array Nur Ereignisse zurückgeben, die von Objekten erstellt wurden, die zu den angegebenen Hosts gehören.
objectids ID/array Nur Ereignisse zurückgeben, die von den angegebenen Objekten erstellt wurden.
source integer Nur Ereignisse mit dem angegebenen Typ zurückgeben.

Eine Liste der unterstützten Ereignistypen finden Sie auf der Seite zum Ereignisobjekt.

Standard: 0 - Auslöser-Ereignisse.
object integer Nur Ereignisse zurückgeben, die von Objekten des angegebenen Typs erstellt wurden.

Eine Liste der unterstützten Objekttypen finden Sie auf der Seite zum Ereignisobjekt.

Standard: 0 - Auslöser.
acknowledged boolean Wenn auf true gesetzt, werden nur bestätigte Ereignisse zurückgegeben.
action integer Nur Ereignisse zurückgeben, für die die angegebenen Aktionen zur Ereignisaktualisierung durchgeführt wurden. Für mehrere Aktionen verwenden Sie die Summe beliebiger zulässiger Bitmap-Werte als Bitmaske (zum Beispiel 34 für das Bestätigen und Unterdrücken eines Ereignisses).
action_userids ID/array Nur Ereignisse mit den angegebenen IDs von Benutzern zurückgeben, die die Aktionen zur Ereignisaktualisierung durchgeführt haben.
suppressed boolean Wenn auf true gesetzt, werden nur unterdrückte Ereignisse zurückgegeben.
symptom boolean Wenn auf true gesetzt, werden nur Symptom-Ereignisse zurückgegeben.
severities integer/array Nur Ereignisse mit den angegebenen Ereignisschweregraden zurückgeben. Gilt nur, wenn object ein Auslöser ist.
trigger_severities integer/array Nur Ereignisse mit den angegebenen Auslöser-Schweregraden zurückgeben. Gilt nur, wenn object ein Auslöser ist.
evaltype integer Methode zur Tag-Auswertung.

Mögliche Werte:
0 - (Standard) Und/Oder;
2 - Oder.
tags array Nur Ereignisse mit den angegebenen Tags zurückgeben.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Ereignisse zurück.

Mögliche Werte für operator:
0 - (Standard) Enthält;
1 - Gleich;
2 - Enthält nicht;
3 - Ungleich;
4 - Existiert;
5 - Existiert nicht.
eventid_from string Nur Ereignisse mit IDs zurückgeben, die größer oder gleich der angegebenen ID sind.
eventid_till string Nur Ereignisse mit IDs zurückgeben, die kleiner oder gleich der angegebenen ID sind.
time_from timestamp Nur Ereignisse zurückgeben, die zum angegebenen Zeitpunkt oder später erstellt wurden.
time_till timestamp Nur Ereignisse zurückgeben, die zum angegebenen Zeitpunkt oder früher erstellt wurden.
problem_time_from timestamp Gibt nur Ereignisse zurück, die sich ab problem_time_from im Problemzustand befanden, unabhängig von ihrem aktuellen Status. Gilt nur, wenn die Quelle ein Auslöser-Ereignis und das Objekt ein Auslöser ist. Dieser Parameter ist erforderlich, wenn problem_time_till angegeben ist.
problem_time_till timestamp Gibt nur Ereignisse zurück, die sich bis problem_time_till im Problemzustand befanden, unabhängig von ihrem aktuellen Status. Gilt nur, wenn die Quelle ein Auslöser-Ereignis und das Objekt ein Auslöser ist. Dieser Parameter ist erforderlich, wenn problem_time_from angegeben ist.
value integer/array Nur Ereignisse mit den angegebenen Werten zurückgeben.
selectAcknowledges query Eine Eigenschaft acknowledges mit Ereignisaktualisierungen zurückgeben. Ereignisaktualisierungen werden in umgekehrter chronologischer Reihenfolge sortiert.

Das Objekt der Ereignisaktualisierung hat die folgenden Eigenschaften:
acknowledgeid - (ID) ID der Bestätigung;
userid - (ID) ID des Benutzers, der das Ereignis aktualisiert hat;
clock - (timestamp) Zeitpunkt, zu dem das Ereignis aktualisiert wurde;
message - (string) Text der Nachricht;
action - (integer) durchgeführte Aktualisierungsaktion, siehe event.acknowledge;
old_severity - (integer) Ereignisschweregrad vor dieser Aktualisierungsaktion;
new_severity - (integer) Ereignisschweregrad nach dieser Aktualisierungsaktion;
suppress_until - (timestamp) Zeitpunkt, bis zu dem das Ereignis unterdrückt wird;
taskid - (ID) ID der Aufgabe, falls für das aktuelle Ereignis gerade eine Rangänderung durchgeführt wird;
username - (string) Benutzername des Benutzers, der das Ereignis aktualisiert hat;
name - (string) Vorname des Benutzers, der das Ereignis aktualisiert hat;
surname - (string) Nachname des Benutzers, der das Ereignis aktualisiert hat.

Unterstützt count.
selectAlerts query Eine Eigenschaft alerts mit den durch das Ereignis erzeugten Warnungen zurückgeben. Warnungen werden in umgekehrter chronologischer Reihenfolge sortiert.
selectHosts query Eine Eigenschaft hosts mit Hosts zurückgeben, die das Objekt enthalten, das das Ereignis erstellt hat. Wird nur für durch Auslöser, Datenpunkte oder LLD-Regeln erzeugte Ereignisse unterstützt.
selectRelatedObject query Eine Eigenschaft relatedObject mit dem Objekt zurückgeben, das das Ereignis erstellt hat. Der Typ des zurückgegebenen Objekts hängt vom Ereignistyp ab.
selectSuppressionData query Eine Eigenschaft suppression_data mit der Liste aktiver Wartungen und manueller Unterdrückungen zurückgeben:
maintenanceid - (ID) ID der Wartung;
userid - (ID) ID des Benutzers, der das Ereignis unterdrückt hat;
suppress_until - (integer) Zeitpunkt, bis zu dem das Ereignis unterdrückt wird.
selectTags query Eine Eigenschaft tags mit Ereignis-Tags zurückgeben.
filter object Nur Ergebnisse zurückgeben, die exakt dem angegebenen Filter entsprechen.

Akzeptiert ein Objekt, bei dem die Schlüssel Eigenschaftsnamen sind und die Werte entweder ein einzelner Wert oder ein Array von Werten sind, mit denen abgeglichen werden soll.

Unterstützt keine Eigenschaften vom text-Datentyp.
sortfield string/array Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: eventid, objectid, clock.

Mögliche Werte bei gemeinsamer Verwendung mit groupBy: objectid.

Mögliche Werte bei gemeinsamer Verwendung mit countOutput und groupBy: objectid, rowscount.
groupBy string/array Die Ergebnisse nach den angegebenen Eigenschaften gruppieren. Die angegebenen Eigenschaften werden in den Ergebnissen zurückgegeben.

Mögliche Werte: objectid.
countOutput boolean Diese Parameter sind in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder:

  • eine Reihe von Objekten zurück;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde, aber der Parameter groupBy nicht verwendet wurde zurück;
  • eine Reihe von Objekten mit Aggregationsergebnissen, wenn der Parameter groupBy verwendet wurde zurück.

Beispiele

Abrufen von Auslöser-Ereignissen

Rufen Sie die neuesten Ereignisse des Auslösers „22395“ ab.

Anfrage:

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

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "20",
            "source": "0",
            "object": "0",
            "objectid": "22395",
            "clock": "1728658089",
            "value": "0",
            "acknowledged": "0",
            "ns": "461809482",
            "name": "Load average is too high (per CPU load over 1.5 for 5m)",
            "severity": "0",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "acknowledges": [],
            "opdata": "Load averages(1m 5m 15m): (1.6328 3.0522 2.2515), # of CPUs: 2",
            "suppression_data": [],
            "suppressed": "0",
            "tags": [
                {
                    "tag": "scope",
                    "value": "capacity"
                },
                {
                    "tag": "scope",
                    "value": "performance"
                },
                {
                    "tag": "component",
                    "value": "cpu"
                },
                {
                    "tag": "class",
                    "value": "os"
                },
                {
                    "tag": "target",
                    "value": "linux"
                }
            ],
            "urls": []
        },
        {
            "eventid": "4",
            "source": "0",
            "object": "0",
            "objectid": "22395",
            "clock": "1728657737",
            "value": "1",
            "acknowledged": "1",
            "ns": "460759366",
            "name": "Load average is too high (per CPU load over 1.5 for 5m)",
            "severity": "3",
            "r_eventid": "20",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "acknowledges": [
                {
                    "acknowledgeid": "1",
                    "userid": "1",
                    "clock": "1728657938",
                    "message": "Testing environment. Please disregard this alert.",
                    "action": "38",
                    "old_severity": "0",
                    "new_severity": "0",
                    "suppress_until": "1728744338",
                    "taskid": "0",
                    "username": "Admin",
                    "name": "Zabbix",
                    "surname": "Administrator"
                }
            ],
            "opdata": "Load averages(1m 5m 15m): (1.6328 3.0522 2.2515), # of CPUs: 2",
            "suppression_data": [
                {
                    "maintenanceid": "0",
                    "suppress_until": "1728744338",
                    "userid": "1"
                }
            ],
            "suppressed": "1",
            "tags": [
                {
                    "tag": "scope",
                    "value": "capacity"
                },
                {
                    "tag": "scope",
                    "value": "performance"
                },
                {
                    "tag": "component",
                    "value": "cpu"
                },
                {
                    "tag": "class",
                    "value": "os"
                },
                {
                    "tag": "target",
                    "value": "linux"
                }
            ],
            "urls": []
        }
    ],
    "id": 1
}

Abrufen von Ereignissen nach Zeitraum

Rufen Sie alle Ereignisse ab, die zwischen dem 17. und 18. Oktober 2012 erstellt wurden, in umgekehrt chronologischer Reihenfolge.

Anfrage:

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

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "20617",
            "source": "0",
            "object": "0",
            "objectid": "14282",
            "clock": "1350477816",
            "value": "1",
            "acknowledged": "0",
            "ns": "0",
            "name": "Weniger als 25 % frei im Verlaufs-Cache",
            "severity": "3",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "opdata": "",
            "suppressed": "0",
            "urls": []
        },
        {
            "eventid": "20616",
            "source": "0",
            "object": "0",
            "objectid": "14281",
            "clock": "1350477814",
            "value": "0",
            "acknowledged": "0",
            "ns": "0",
            "name": "Zabbix-Trapper-Prozesse sind zu mehr als 75 % ausgelastet",
            "severity": "0",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "opdata": "",
            "suppressed": "0",
            "urls": []
        },
        {
            "eventid": "20615",
            "source": "0",
            "object": "0",
            "objectid": "14281",
            "clock": "1350477541",
            "value": "1",
            "acknowledged": "0",
            "ns": "0",
            "name": "Zabbix-Trapper-Prozesse sind zu mehr als 75 % ausgelastet",
            "severity": "3",
            "r_eventid": "20616",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "opdata": "",
            "suppressed": "0",
            "urls": []
        }
    ],
    "id": 1
}

Abrufen von Ereignissen, die von einem angegebenen Benutzer bestätigt wurden

Abrufen von Ereignissen, die von einem Benutzer mit ID=10 bestätigt wurden

Anfrage:

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

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "503",
            "source": "0",
            "object": "0",
            "objectid": "23162",
            "clock": "1747212236",
            "value": "1",
            "acknowledged": "1",
            "ns": "413470863",
            "name": "Number of installed packages has been changed",
            "severity": "2",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "acknowledges": [
                {
                    "userid": "10",
                    "action": "2"
                }
            ],
            "opdata": "",
            "suppressed": "0",
            "urls": []
        }
    ],
    "id": 1
}

Abrufen der Top-5-Auslöser nach Anzahl der Problemereignisse

Rufen Sie die 5 wichtigsten Auslöser mit den Schweregraden „Warning“, „Average“, „High“ oder „Disaster“ zusammen mit der Anzahl der Problemereignisse innerhalb eines angegebenen Zeitraums ab.

Anfrage:

{
    "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
}

Antwort:

{
    "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
}

Siehe auch

Quelle

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