trigger.get

Beschreibung

integer/array trigger.get(object parameters)

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

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufrufen der Methode kann 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 Type Description
triggerids ID/array Gibt nur Auslöser mit den angegebenen IDs zurück.
groupids ID/array Gibt nur Auslöser zurück, die zu Hosts oder Vorlagen aus den angegebenen Hostgruppen oder Vorlagengruppen gehören.
templateids ID/array Gibt nur Auslöser zurück, die zu den angegebenen Vorlagen gehören.
hostids ID/array Gibt nur Auslöser zurück, die zu den angegebenen Hosts gehören.
itemids ID/array Gibt nur Auslöser zurück, die die angegebenen Datenpunkte enthalten.
maintenanceids ID/array Gibt nur Auslöser zurück, die von den angegebenen Wartungen betroffen sind.
functions string/array Gibt nur Auslöser zurück, die die angegebenen Funktionen verwenden.

Eine Liste der unterstützten Funktionen finden Sie auf der Seite Unterstützte Funktionen.
group string Gibt nur Auslöser zurück, die zu Hosts oder Vorlagen aus der Hostgruppe oder Vorlagengruppe mit dem angegebenen Namen gehören.
host string Gibt nur Auslöser zurück, die zum Host mit dem angegebenen technischen Namen gehören.
inherited boolean Wenn auf true gesetzt, werden nur von einer Vorlage geerbte Auslöser zurückgegeben.
templated boolean Wenn auf true gesetzt, werden nur Auslöser zurückgegeben, die zu Vorlagen gehören.
dependent boolean Wenn auf true gesetzt, werden nur Auslöser zurückgegeben, die Abhängigkeiten haben. Wenn auf false gesetzt, werden nur Auslöser zurückgegeben, die keine Abhängigkeiten haben.
monitored flag Gibt nur aktivierte Auslöser zurück, die zu überwachten Hosts gehören und ausschließlich aktivierte Datenpunkte enthalten.
active flag Gibt nur aktivierte Auslöser zurück, die zu überwachten Hosts gehören.
maintenance boolean Wenn auf true gesetzt, werden nur aktivierte Auslöser zurückgegeben, die zu Hosts im Wartungsmodus gehören.
withUnacknowledgedEvents flag Gibt nur Auslöser zurück, für die nicht bestätigte Ereignisse vorhanden sind.
withAcknowledgedEvents flag Gibt nur Auslöser zurück, für die alle Ereignisse bestätigt wurden.
withLastEventUnacknowledged flag Gibt nur Auslöser zurück, deren letztes Ereignis nicht bestätigt wurde.
skipDependent flag Überspringt Auslöser im Problemzustand, die von anderen Auslösern abhängig sind. Beachten Sie, dass die anderen Auslöser ignoriert werden, wenn sie deaktiviert sind, deaktivierte Datenpunkte haben oder zu Hosts mit deaktivierten Datenpunkten gehören.
lastChangeSince timestamp Gibt nur Auslöser zurück, deren Zustand nach dem angegebenen Zeitpunkt geändert wurde.
lastChangeTill timestamp Gibt nur Auslöser zurück, deren Zustand vor dem angegebenen Zeitpunkt geändert wurde.
only_true flag Gibt nur Auslöser zurück, die sich kürzlich in einem Problemzustand befunden haben (innerhalb von ok_period).
min_severity integer Gibt nur Auslöser zurück, deren Schweregrad größer oder gleich dem angegebenen Schweregrad ist.
evaltype integer Auswertungsmethode für Tags.

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

Mögliche Werte für Operatoren:
0 - (Standard) Enthält;
1 - Ist gleich;
2 - Enthält nicht;
3 - Ist nicht gleich;
4 - Ist vorhanden;
5 - Ist nicht vorhanden.
expandComment flag Erweitert Makros in der Beschreibung des Auslösers.
expandDescription flag Erweitert Makros im Namen des Auslösers.
expandExpression flag Erweitert Funktionen und Makros im Ausdruck des Auslösers.
selectHostGroups query Gibt die Hostgruppen, zu denen der Auslöser gehört, in der Eigenschaft hostgroups zurück.
selectHosts query Gibt die Hosts, zu denen der Auslöser gehört, in der Eigenschaft hosts zurück.
selectItems query Gibt die im Auslöser enthaltenen Datenpunkte in der Eigenschaft items zurück.
selectFunctions query Gibt die im Auslöser verwendeten Funktionen in der Eigenschaft functions zurück.

Die Funktionsobjekte stellen die im Ausdruck des Auslösers 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 in der zurückgegebenen Zeichenfolge durch das Symbol $ ersetzt.
selectDependencies query Gibt die Auslöser, von denen der Auslöser abhängig ist, in der Eigenschaft dependencies zurück.
selectDiscoveryData query Gibt eine Eigenschaft discoveryData mit den Daten des Auslöser-Discovery-Objekts zurück. Das Auslöser-Discovery-Objekt verknüpft einen erkannten Auslöser mit einem Auslöser-Prototyp, aus dem er erkannt wurde.

Es hat die folgenden Eigenschaften:
parent_triggerid - (ID) ID des Auslöser-Prototyps, aus dem der Auslöser erstellt wurde;
status - (int) Discovery-Status des Auslösers:
0 - (Standard) Auslöser wurde erkannt,
1 - Auslöser wird nicht mehr erkannt;
ts_delete - (timestamp) Zeitpunkt, zu dem ein nicht mehr erkannter Auslöser gelöscht wird;
ts_disable - (timestamp) Zeitpunkt, zu dem ein nicht mehr erkannter Auslöser deaktiviert wird;
disable_source - (int) Gibt an, ob der Auslöser durch eine LLD-Regel oder manuell deaktiviert wurde:
0 - (Standard) automatisch deaktiviert,
1 - durch eine LLD-Regel deaktiviert.
selectDiscoveryRule query Gibt die Low-Level-Discovery-Regel, durch die der Auslöser erstellt wurde, in der Eigenschaft discoveryRule zurück.
selectLastEvent query Gibt das letzte relevante Auslöserereignis in der Eigenschaft lastEvent zurück.
selectTags query Gibt die Tags des Auslösers in der Eigenschaft tags zurück.
inheritedTags boolean Gibt Auslöser zurück, die die angegebenen tags auch in der Vorlage, dem Host oder verknüpften Vorlagen haben.

Mögliche Werte:
true - Vorlage, Host oder verknüpfte Vorlagen müssen die angegebenen Tags ebenfalls haben;
false - (Standard) Tags aus Vorlage, Host oder verknüpften Vorlagen werden ignoriert.
selectInheritedTags query Gibt eine Eigenschaft inheritedTags mit von Vorlagen, verknüpften Vorlagen und Hosts sowie von in Auslöser- oder Wiederherstellungsausdrücken referenzierten Datenpunkten geerbten Tags zurück.
selectTemplateGroups query Gibt die Vorlagengruppen, zu denen der Auslöser gehört, in der Eigenschaft templategroups zurück.
filter object Gibt nur Ergebnisse zurück, die exakt mit dem angegebenen Filter übereinstimmen.

Akzeptiert ein Objekt, dessen Schlüssel Eigenschaftsnamen und dessen Werte entweder ein einzelner Wert oder ein Array von abzugleichenden Werten sind.

Unterstützt keine Eigenschaften des Datentyps 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 Sortiert das Ergebnis nach den angegebenen Eigenschaften (Sortierung).

Mögliche Werte: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Diese Parameter werden in der Referenzdokumentation beschrieben.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectTriggerDiscovery query Gibt das Discovery-Objekt des Auslösers in der Eigenschaft triggerDiscovery zurück. Die Auslöser-Discovery-Objekte verknüpfen den Auslöser mit einem Auslöser-Prototyp, aus dem er erstellt wurde.

Diese Abfrage ist veraltet. 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 nach Auslöser-ID

Rufen Sie alle Daten und die im 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",
                    "triggerid": "14062",
                    "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\")}",
                    "automatic": "1"
                },
                {
                    "tag": "error",
                    "value": "",
                    "automatic": "1"
                }
            ]
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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