trigger.get

Beschreibung

integer/array trigger.get(object parameters)

Die Methode ermöglicht das Abrufen von Auslösern anhand der angegebenen Parameter.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle entzogen 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
triggerids ID/array Nur Auslöser mit den angegebenen IDs zurückgeben.
groupids ID/array Nur Auslöser zurückgeben, die zu Hosts oder Vorlagen aus den angegebenen Hostgruppen oder Vorlagengruppen gehören.
templateids ID/array Nur Auslöser zurückgeben, die zu den angegebenen Vorlagen gehören.
hostids ID/array Nur Auslöser zurückgeben, die zu den angegebenen Hosts gehören.
itemids ID/array Nur Auslöser zurückgeben, die die angegebenen Datenpunkte enthalten.
functions string/array Nur Auslöser zurückgeben, die die angegebenen Funktionen verwenden.

Eine Liste der unterstützten Funktionen finden Sie auf der Seite unterstützte Funktionen.
group string Nur Auslöser zurückgeben, die zu Hosts oder Vorlagen aus der Hostgruppe oder Vorlagengruppe mit dem angegebenen Namen gehören.
host string Nur Auslöser zurückgeben, die zu dem Host mit dem angegebenen technischen Namen gehören.
inherited boolean Wenn auf true gesetzt, nur Auslöser zurückgeben, die von einer Vorlage geerbt wurden.
templated boolean Wenn auf true gesetzt, nur Auslöser zurückgeben, die zu Vorlagen gehören.
dependent boolean Wenn auf true gesetzt, nur Auslöser zurückgeben, die Abhängigkeiten haben. Wenn auf false gesetzt, nur Auslöser zurückgeben, die keine Abhängigkeiten haben.
monitored flag Nur aktivierte Auslöser zurückgeben, die zu überwachten Hosts gehören und nur aktivierte Datenpunkte enthalten.
active flag Nur aktivierte Auslöser zurückgeben, die zu überwachten Hosts gehören.
maintenance boolean Wenn auf true gesetzt, nur aktivierte Auslöser zurückgeben, die zu Hosts in Wartung gehören.
withUnacknowledgedEvents flag Nur Auslöser zurückgeben, die nicht bestätigte Ereignisse haben.
withAcknowledgedEvents flag Nur Auslöser mit allen bestätigten Ereignissen zurückgeben.
withLastEventUnacknowledged flag Nur Auslöser zurückgeben, bei denen das letzte Ereignis nicht bestätigt ist.
skipDependent flag Auslöser im Problemzustand überspringen, die von anderen Auslösern abhängig sind. Beachten Sie, dass die anderen Auslöser ignoriert werden, wenn sie deaktiviert sind, deaktivierte Datenpunkte oder Hosts mit deaktivierten Datenpunkten haben.
lastChangeSince timestamp Nur Auslöser zurückgeben, deren Zustand sich nach der angegebenen Zeit geändert hat.
lastChangeTill timestamp Nur Auslöser zurückgeben, deren Zustand sich vor der angegebenen Zeit geändert hat.
only_true flag Nur Auslöser zurückgeben, die sich kürzlich in einem Problemzustand befunden haben.
min_severity integer Nur Auslöser mit einer Schwere größer oder gleich der angegebenen Schwere zurückgeben.
evaltype integer Tag-Auswertungsmethode.

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

Mögliche Operator-Werte:
0 - (Standard) Enthält;
1 - Entspricht;
2 - Enthält nicht;
3 - Entspricht nicht;
4 - Existiert;
5 - Existiert nicht.
expandComment flag Makros in der Auslöserbeschreibung erweitern.
expandDescription flag Makros im Namen des Auslösers erweitern.
expandExpression flag Funktionen und Makros in der Auslöserausdruck erweitern.
selectHostGroups query Die Hostgruppen zurückgeben, zu denen der Auslöser gehört, in der Eigenschaft hostgroups.
selectHosts query Die Hosts zurückgeben, zu denen der Auslöser gehört, in der Eigenschaft hosts.
selectItems query Die vom Auslöser enthaltenen Datenpunkte in der Eigenschaft items zurückgeben.
selectFunctions query Die im Auslöser verwendeten Funktionen in der Eigenschaft functions zurückgeben.

Die Funktionsobjekte stellen die im Auslöserausdruck verwendeten Funktionen dar und haben die folgenden Eigenschaften:
functionid - (ID) ID der Funktion;
itemid - (ID) ID des in der Funktion verwendeten Datenpunkts;
function - (string) Name der Funktion;
parameter - (string) an die Funktion übergebener Parameter. Der Abfrageparameter wird im zurückgegebenen String durch das Symbol $ ersetzt.
selectDependencies query Die Auslöser zurückgeben, von denen der Auslöser abhängt, in der Eigenschaft dependencies.
selectDiscoveryData query Eine Eigenschaft discoveryData mit den Daten des Auslöser-Discovery-Objekts zurückgeben. Das Auslöser-Discovery-Objekt verknüpft einen entdeckten Auslöser mit einer Auslöservorlage, aus der er entdeckt wurde.

Es hat die folgenden Eigenschaften:
parent_triggerid - (ID) ID der Auslöservorlage, aus der der Auslöser erstellt wurde;
status - (int) Status der Auslöser-Discovery:
0 - (Standard) Auslöser wurde entdeckt,
1 - Auslöser wird nicht mehr entdeckt;
ts_delete - (timestamp) Zeitpunkt, zu dem ein nicht mehr entdeckter Auslöser gelöscht wird;
ts_disable - (timestamp) Zeitpunkt, zu dem ein nicht mehr entdeckter Auslöser deaktiviert wird;
disable_source - (int) Kennzeichnung, ob der Auslöser durch eine LLD-Regel oder manuell deaktiviert wurde:
0 - (Standard) automatisch deaktiviert,
1 - durch eine LLD-Regel deaktiviert.
selectDiscoveryRule query Die Low-Level-Discovery-Regel zurückgeben, die den Auslöser in der Eigenschaft discoveryRule erstellt hat.
selectLastEvent query Das letzte signifikante Auslöserereignis in der Eigenschaft lastEvent zurückgeben.
selectTags query Die Auslöser-Tags in der Eigenschaft tags zurückgeben.
selectTemplateGroups query Die Vorlagengruppen zurückgeben, zu denen der Auslöser gehört, in der Eigenschaft templategroups.
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 verglichen werden soll.

Unterstützt keine Eigenschaften vom Datentyp text.

Unterstützt zusätzliche Eigenschaften:
host - technischer Name des Hosts, zu dem der Auslöser gehört;
hostid - ID des Hosts, zu dem der Auslöser gehört.
limitSelects integer Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze.

Gilt für die folgenden Unterabfragen:
selectHosts - Ergebnisse werden nach host sortiert.
sortfield string/array Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Diese Parameter werden im Referenzkommentar beschrieben.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectTriggerDiscovery query Das Auslöser-Discovery-Objekt in der Eigenschaft triggerDiscovery zurückgeben. Die Auslöser-Discovery-Objekte verknüpfen den Auslöser mit einer Auslöservorlage, aus der er erstellt wurde.

Diese Abfrage ist veraltet, bitte verwenden Sie stattdessen selectDiscoveryData.

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 Daten anhand der Auslöser-ID

Rufen Sie alle Daten und die in Auslöser "14062" verwendeten Funktionen ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "triggerids": "14062",
        "output": "extend",
        "selectFunctions": "extend"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "14062",
            "expression": "{13513}<10m",
            "description": "{HOST.NAME} has been restarted (uptime < 10m)",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "The host uptime is less than 10 minutes",
            "error": "",
            "templateid": "10016",
            "type": "0",
            "state": "0",
            "flags": "0",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "event_name": "",
            "uuid": "",
            "url_name": "",
            "functions": [
                {
                    "functionid": "13513",
                    "itemid": "24350",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Auslöser im Problemzustand abrufen

Rufen Sie die ID, den Namen und den Schweregrad aller Auslöser im Problemzustand ab und sortieren Sie sie nach Schweregrad in absteigender Reihenfolge.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description",
            "priority"
        ],
        "filter": {
            "value": 1
        },
        "sortfield": "priority",
        "sortorder": "DESC"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "13907",
            "description": "Zabbix-Selbstüberwachungsprozesse < 100 % ausgelastet",
            "priority": "4"
        },
        {
            "triggerid": "13824",
            "description": "Zabbix-Discoverer-Prozesse mehr als 75 % ausgelastet",
            "priority": "3"
        }
    ],
    "id": 1
}

Abrufen eines bestimmten Auslösers mit Tags

Rufen Sie einen bestimmten Auslöser mit Tags ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description"
        ],
        "selectTags": "extend",
        "triggerids": [
            "17578"
        ]
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17370",
            "description": "Service status",
            "tags": [
                {
                    "tag": "service",
                    "value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
                },
                {
                    "tag": "error",
                    "value": ""
                }
            ]
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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