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 Type Beschreibung
alertids ID/array Gibt nur Warnungen mit den angegebenen IDs zurück.
actionids ID/array Gibt nur Warnungen zurück, die durch die angegebenen Aktionen erzeugt wurden.
eventids ID/array Gibt nur Warnungen zurück, die durch die angegebenen Ereignisse erzeugt wurden.
groupids ID/array Gibt nur Warnungen zurück, die durch Objekte aus den angegebenen Host-Gruppen erzeugt wurden.
hostids ID/array Gibt nur Warnungen zurück, die durch Objekte aus den angegebenen Hosts erzeugt wurden.
mediatypeids ID/array Gibt nur Nachrichtenwarnungen zurück, die die angegebenen Medientypen verwendet haben.
objectids ID/array Gibt nur Warnungen zurück, die durch die angegebenen Objekte erzeugt wurden
userids ID/array Gibt nur Nachrichtenwarnungen zurück, die an die angegebenen Benutzer gesendet wurden.
eventobject integer Gibt nur Warnungen zurück, die durch Ereignisse erzeugt wurden, die sich auf Objekte des angegebenen Typs beziehen.

Eine Liste der unterstützten Objekttypen finden Sie unter Ereignis-object.

Standard: 0 - Auslöser.
eventsource integer Gibt nur Warnungen zurück, die durch Ereignisse des angegebenen Typs erzeugt wurden.

Eine Liste der unterstützten Ereignistypen finden Sie unter Ereignis-source.

Standard: 0 - Auslöser-Ereignisse.
time_from timestamp Gibt nur Warnungen zurück, die nach dem angegebenen Zeitpunkt erzeugt wurden.
time_till timestamp Gibt nur Warnungen zurück, die vor dem angegebenen Zeitpunkt erzeugt wurden.
selectHosts query Gibt eine Eigenschaft hosts mit Daten von Hosts zurück, die die Aktionsoperation ausgelöst haben.
selectMediatypes query Gibt eine Eigenschaft mediatypes mit einem Array der Medientypen zurück, die für die Nachrichtenwarnung verwendet wurden.

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

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

Mögliche Werte: alertid, clock, eventid, mediatypeid, sendto, status.
countOutput boolean Diese Parameter sind 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

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

Warnungen nach Aktions-ID abrufen

Rufen Sie alle Warnungen ab, die durch die Aktion „3“ erzeugt wurden.

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 on Linux server is unreachable for 5 minutes: ",
            "message": "Trigger: Zabbix agent on Linux server is unreachable for 5 minutes: \nTrigger state: PROBLEM\nTrigger severity: Not classified",
            "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.