problem.get

Beschreibung

integer/array problem.get(object parameters)

Die Methode ermöglicht es Ihnen, Probleme anhand der angegebenen Parameter abzurufen.

Diese Methode dient zum Abrufen ungelöster Probleme. Falls angegeben, ist es außerdem möglich, zusätzlich kürzlich gelöste Probleme abzurufen. Der Zeitraum, der festlegt, wie alt "kürzlich" ist, wird unter Administration > Allgemein definiert. Probleme, die vor diesem Zeitraum gelöst wurden, werden nicht in der Problem-Tabelle aufbewahrt. Um Probleme abzurufen, die weiter in der Vergangenheit gelöst wurden, verwenden Sie die Methode event.get.

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

Diese Methode ist für Benutzer aller Typen verfügbar. Berechtigungen zum Aufruf der Methode können in den Einstellungen der Benutzerrolle widerrufen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

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

Die Methode unterstützt die folgenden Parameter.

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

Eine Liste der unterstützten Ereignistypen finden Sie auf der Seite des Problemereignisobjekts.

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

Eine Liste der unterstützten Objekttypen finden Sie auf der Seite des Problemereignisobjekts.

Standard: 0 - Auslöser.
acknowledged boolean Wenn auf true gesetzt, nur bestätigte Probleme zurückgeben.
action integer Nur Probleme zurückgeben, für die die angegebenen Ereignis-Aktualisierungsaktionen ausgeführt wurden. Für mehrere Aktionen verwenden Sie eine Summe beliebiger zulässiger Bitmap-Werte als Bitmaske (zum Beispiel 34 für Bestätigung und Unterdrückung des Ereignisses).
action_userids ID/array Nur Probleme mit den angegebenen IDs von Benutzern zurückgeben, die die Ereignis-Aktualisierungsaktionen für das Problem ausgeführt haben.
suppressed boolean Wenn auf true gesetzt, nur unterdrückte Probleme zurückgeben.
symptom boolean Wenn auf true gesetzt, nur Symptom-Problemereignisse zurückgeben.
severities integer/array Nur Probleme mit den angegebenen Ereignisschweregraden zurückgeben. Gilt nur, wenn object ein Auslöser ist.
evaltype integer Tag-Auswertungsmethode.

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

Mögliche Operator-Werte:
0 - (Standard) Enthält;
1 - Ist gleich;
2 - Enthält nicht;
3 - Ist nicht gleich;
4 - Existiert;
5 - Existiert nicht.
recent boolean Wenn auf true gesetzt, aktuelle Probleme zurückgeben, einschließlich derjenigen, die innerhalb des ok_period behoben wurden, sowie aller nicht behobenen Probleme.
Wenn auf false gesetzt, nur nicht behobene Probleme zurückgeben.
eventid_from string Nur Probleme mit IDs größer oder gleich der angegebenen ID zurückgeben.
eventid_till string Nur Probleme mit IDs kleiner oder gleich der angegebenen ID zurückgeben.
time_from timestamp Nur Probleme zurückgeben, die nach oder zum angegebenen Zeitpunkt erstellt wurden.
time_till timestamp Nur Probleme zurückgeben, die vor oder zum angegebenen Zeitpunkt erstellt wurden.
selectAcknowledges query Eine Eigenschaft acknowledges mit den Problemaktualisierungen zurückgeben. Problemaktualisierungen werden in umgekehrt chronologischer Reihenfolge sortiert.

Das Problemaktualisierungsobjekt hat die folgenden Eigenschaften:
acknowledgeid - (ID) ID der Aktualisierung;
userid - (ID) ID des Benutzers, der das Ereignis aktualisiert hat;
eventid - (ID) ID des aktualisierten Ereignisses;
clock - (timestamp) Zeitpunkt, zu dem das Ereignis aktualisiert wurde;
message - (string) Text der Nachricht;
action - (integer) Typ der 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, wenn das aktuelle Ereignis einen Rangwechsel durchläuft;
maintenanceid - (ID) ID der Wartung.

Unterstützt count.
selectTags query Eine Eigenschaft tags mit den Problem-Tags zurückgeben. Ausgabeformat: [{"tag": "<tag>", "value": "<value>"}, ...].
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 Problem unterdrückt hat;
suppress_until - (integer) Zeit, bis zu der das Problem unterdrückt ist.
filter object Nur diejenigen 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 verglichen werden soll.

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

Mögliche Werte: eventid.
countOutput boolean Diese Parameter werden in der Referenzbeschreibung erläutert.
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 Folgendes zurück:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Abrufen von Auslöser-Problemereignissen

Rufen Sie aktuelle Ereignisse von Auslöser "15112" ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "problem.get",
    "params": {
        "output": "extend",
        "selectAcknowledges": "extend",
        "selectTags": "extend",
        "selectSuppressionData": "extend",
        "objectids": "15112",
        "recent": true,
        "sortfield": ["eventid"],
        "sortorder": "DESC"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "1245463",
            "source": "0",
            "object": "0",
            "objectid": "15112",
            "clock": "1472457242",
            "ns": "209442442",
            "r_eventid": "1245468",
            "r_clock": "1472457285",
            "r_ns": "125644870",
            "correlationid": "0",
            "userid": "1",
            "name": "Zabbix Agent auf localhost ist seit 5 Minuten nicht erreichbar",
            "acknowledged": "1",
            "severity": "3",
            "cause_eventid": "0",
            "suppressed": "1",
            "acknowledges": [
                {
                    "acknowledgeid": "14443",
                    "userid": "1",
                    "eventid": "1245463",
                    "clock": "1472457281",
                    "message": "problem solved",
                    "action": "6",
                    "old_severity": "0",
                    "new_severity": "0",
                    "suppress_until": "1472511600",
                    "taskid": "0",
                    "maintenanceid": "0"
                }
            ],
            "opdata": "",
            "suppression_data": [
                {
                    "maintenanceid": "15",
                    "suppress_until": "1472511600",
                    "userid": "0"
                }
            ],
            "tags": [
                {
                    "tag": "test-tag",
                    "value": "test-value"
                }
            ],
            "urls": []
        }
    ],
    "id": 1
}

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

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

Anfrage:

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

Antwort:

{
    "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",
            "suppressed": "0",
            "acknowledges": [
                {
                    "acknowledgeid": "9",
                    "userid": "10",
                    "action": "2"
                }
            ],
            "opdata": "",
            "urls": []
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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