alert.get

Beschreibung

integer/array alert.get(object parameters)

Die Methode ermöglicht den Abruf von Warnmeldungen entsprechend den angegebenen Parametern.

Diese Methode steht Nutzern jeder Art zur Verfügung. Die Berechtigung zum Aufruf der Methode kann in den Benutzerrolleneinstellungen 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
alertids ID/array Nur Alerts mit den angegebenen IDs zurückgeben.
actionids ID/array Nur Alerts zurückgeben, die von den angegebenen Aktionen erzeugt wurden.
eventids ID/array Nur Alerts zurückgeben, die von den angegebenen Ereignissen erzeugt wurden.
groupids ID/array Nur Alerts zurückgeben, die von Objekten aus den angegebenen Hostgruppen erzeugt wurden.
hostids ID/array Nur Alerts zurückgeben, die von Objekten aus den angegebenen Hosts erzeugt wurden.
mediatypeids ID/array Nur Nachrichten-Alerts zurückgeben, die die angegebenen Medientypen verwendet haben.
objectids ID/array Nur Alerts zurückgeben, die von den angegebenen Objekten erzeugt wurden
userids ID/array Nur Nachrichten-Alerts zurückgeben, die an die angegebenen Benutzer gesendet wurden.
eventobject integer Nur Alerts zurückgeben, die von Ereignissen im Zusammenhang mit Objekten des angegebenen Typs erzeugt wurden.

Siehe event object für eine Liste der unterstützten Objekttypen.

Standard: 0 - Auslöser.
eventsource integer Nur Alerts zurückgeben, die von Ereignissen des angegebenen Typs erzeugt wurden.

Siehe event source für eine Liste der unterstützten Ereignistypen.

Standard: 0 - Auslöser-Ereignisse.
time_from timestamp Nur Alerts zurückgeben, die nach der angegebenen Zeit erzeugt wurden.
time_till timestamp Nur Alerts zurückgeben, die vor der angegebenen Zeit erzeugt wurden.
selectHosts query Eine Eigenschaft hosts mit Daten der Hosts zurückgeben, die die Aktionsoperation ausgelöst haben.
selectMediatypes query Eine Eigenschaft mediatypes mit einem Array der Medientypen zurückgeben, die für den Nachrichten-Alert verwendet wurden.

Siehe mediatype.get für Einschränkungen basierend auf dem Benutzertyp.
selectUsers query Eine Eigenschaft users mit einem Array der Benutzer zurückgeben, an die die Nachricht adressiert war.

Siehe user.get für Einschränkungen basierend auf dem Benutzertyp.
sortfield string/array Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: alertid, clock, eventid, mediatypeid, sendto, status.
countOutput boolean Diese Parameter werden in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

In Zabbix 7.0.9 können Benutzer vom Typ Admin und User Alert-Daten vom Typ "message" (0) nur über ihren eigenen Benutzer abrufen.

Rückgabewerte

(integer/array) kann die folgenden Dinge zurück geben:

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

Beispiele

Abrufe von Alarmen nach Aktions-ID

Rufen Sie alle von der Aktion "3" erzeugten Alarme ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "alert.get",
    "params": {
        "output": "extend",
        "actionids": "3"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "alertid": "1",
            "actionid": "3",
            "eventid": "21243",
            "userid": "1",
            "clock": "1362128008",
            "mediatypeid": "1",
            "sendto": "[email protected]",
            "subject": "PROBLEM: Zabbix Agent auf Linux-Server ist seit 5 Minuten nicht erreichbar: ",
            "message": "Auslöser: Zabbix Agent auf Linux-Server ist seit 5 Minuten nicht erreichbar: \nAuslöserstatus: PROBLEM\nAuslöserschweregrad: Nicht klassifiziert",
            "status": "0",
            "retries": "3",
            "error": "",
            "esc_step": "1",
            "alerttype": "0",
            "p_eventid": "0",
            "acknowledgeid": "0"
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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