trigger.get

Opis

integer/array trigger.get(object parameters)

Metoda umożliwia pobieranie wyzwalaczy zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody można odebrać w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Parametry

(object) Parametry definiujące oczekiwany wynik.

Metoda obsługuje następujące parametry.

Parameter Type Description
triggerids ID/array Zwracaj tylko wyzwalacze o podanych ID.
groupids ID/array Zwracaj tylko wyzwalacze należące do hostów lub szablonów z podanych grup hostów lub grup szablonów.
templateids ID/array Zwracaj tylko wyzwalacze należące do podanych szablonów.
hostids ID/array Zwracaj tylko wyzwalacze należące do podanych hostów.
itemids ID/array Zwracaj tylko wyzwalacze zawierające podane pozycje.
functions string/array Zwracaj tylko wyzwalacze, które używają podanych funkcji.

Listę obsługiwanych funkcji znajdziesz na stronie supported function.
group string Zwracaj tylko wyzwalacze należące do hostów lub szablonów z grupy hostów lub grupy szablonów o podanej nazwie.
host string Zwracaj tylko wyzwalacze należące do hosta o podanej nazwie technicznej.
inherited boolean Jeśli ustawione na true, zwracaj tylko wyzwalacze odziedziczone z szablonu.
templated boolean Jeśli ustawione na true, zwracaj tylko wyzwalacze należące do szablonów.
dependent boolean Jeśli ustawione na true, zwracaj tylko wyzwalacze, które mają zależności. Jeśli ustawione na false, zwracaj tylko wyzwalacze, które nie mają zależności.
monitored flag Zwracaj tylko włączone wyzwalacze należące do monitorowanych hostów i zawierające wyłącznie włączone pozycje.
active flag Zwracaj tylko włączone wyzwalacze należące do monitorowanych hostów.
maintenance boolean Jeśli ustawione na true, zwracaj tylko włączone wyzwalacze należące do hostów w konserwacji.
withUnacknowledgedEvents flag Zwracaj tylko wyzwalacze z niepotwierdzonymi zdarzeniami.
withAcknowledgedEvents flag Zwracaj tylko wyzwalacze, dla których wszystkie zdarzenia zostały potwierdzone.
withLastEventUnacknowledged flag Zwracaj tylko wyzwalacze, dla których ostatnie zdarzenie jest niepotwierdzone.
skipDependent flag Pomiń wyzwalacze w stanie problemu, które są zależne od innych wyzwalaczy. Zwróć uwagę, że inne wyzwalacze są ignorowane, jeśli są wyłączone, mają wyłączone pozycje lub wyłączonych hostów pozycji.
lastChangeSince timestamp Zwracaj tylko wyzwalacze, które zmieniły swój stan po podanym czasie.
lastChangeTill timestamp Zwracaj tylko wyzwalacze, które zmieniły swój stan przed podanym czasem.
only_true flag Zwracaj tylko wyzwalacze, które ostatnio były w stanie problemu.
min_severity integer Zwracaj tylko wyzwalacze o ważności większej lub równej podanej ważności.
evaltype integer Tag evaluation method.

Possible values:
0 - (default) And/Or;
2 - Or.
tags array Zwracaj tylko wyzwalacze z podanymi tagami.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Pusta tablica zwraca wszystkie wyzwalacze.

Możliwe wartości operator:
0 - (default) Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.
expandComment flag Rozwiń makra w opisie wyzwalacza.
expandDescription flag Rozwiń makra w nazwie wyzwalacza.
expandExpression flag Rozwiń funkcje i makra w wyrażeniu wyzwalacza.
selectHostGroups query Zwracaj grupy hostów, do których należy wyzwalacz, w właściwości hostgroups.
selectHosts query Zwracaj hosty, do których należy wyzwalacz, w właściwości hosts.
selectItems query Zwracaj pozycje zawarte w wyzwalaczu w właściwości items.
selectFunctions query Zwracaj funkcje używane w wyzwalaczu w właściwości functions.

Obiekty funkcji reprezentują funkcje używane w wyrażeniu wyzwalacza i mają następujące właściwości:
functionid - (ID) ID funkcji;
itemid - (ID) ID pozycji używanej w funkcji;
function - (string) nazwa funkcji;
parameter - (string) parametr przekazany do funkcji. Parametr zapytania jest zastępowany symbolem $ w zwracanym ciągu.
selectDependencies query Zwracaj wyzwalacze, od których zależy wyzwalacz, w właściwości dependencies.
selectDiscoveryData query Zwracaj właściwość discoveryData z danymi obiektu wykrywania wyzwalacza. Obiekt wykrywania wyzwalacza łączy wykryty wyzwalacz z prototypem wyzwalacza, z którego został wykryty.

Ma następujące właściwości:
parent_triggerid - (ID) ID prototypu wyzwalacza, z którego został utworzony wyzwalacz;
status - (int) status wykrywania wyzwalacza:
0 - (default) wyzwalacz został wykryty,
1 - wyzwalacz nie jest już wykrywany;
ts_delete - (timestamp) czas, po którym wyzwalacz, który nie jest już wykrywany, zostanie usunięty;
ts_disable - (timestamp) czas, po którym wyzwalacz, który nie jest już wykrywany, zostanie wyłączony;
disable_source - (int) wskaźnik, czy wyzwalacz został wyłączony przez regułę LLD, czy ręcznie:
0 - (default) wyłączony automatycznie,
1 - wyłączony przez regułę LLD.
selectDiscoveryRule query Zwracaj regułę wykrywania niskopoziomowego, która utworzyła wyzwalacz, w właściwości discoveryRule.
selectLastEvent query Zwracaj ostatnie istotne zdarzenie wyzwalacza w właściwości lastEvent.
selectTags query Zwracaj tagi wyzwalacza w właściwości tags.
selectTemplateGroups query Zwracaj grupy szablonów, do których należy wyzwalacz, w właściwości templategroups.
filter object Zwracaj tylko te wyniki, które dokładnie pasują do podanego filtra.

Przyjmuje obiekt, w którym klucze są nazwami właściwości, a wartościami jest pojedyncza wartość lub tablica wartości, z którymi ma nastąpić dopasowanie.

Nie obsługuje właściwości typu danych text data type.

Obsługuje dodatkowe właściwości:
host - nazwa techniczna hosta, do którego należy wyzwalacz;
hostid - ID hosta, do którego należy wyzwalacz.
limitSelects integer Ogranicza liczbę rekordów zwracanych przez podzapytania.

Dotyczy następujących podzapytań:
selectHosts - wyniki będą sortowane według host.
sortfield string/array Sortuj wynik według podanych właściwości.

Możliwe wartości: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Te parametry są opisane w reference commentary.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectTriggerDiscovery query Zwracaj obiekt wykrywania wyzwalacza w właściwości triggerDiscovery. Obiekty wykrywania wyzwalacza łączą wyzwalacz z prototypem wyzwalacza, z którego został utworzony.

To zapytanie jest przestarzałe, zamiast niego użyj selectDiscoveryData.

Zwracane wartości

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli został użyty parametr countOutput.

Przykłady

Pobieranie danych według ID wyzwalacza

Pobierz wszystkie dane oraz funkcje użyte w wyzwalaczu "14062".

Żądanie:

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

Odpowiedź:

{
    "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
}

Pobieranie wyzwalaczy w stanie problemu

Pobierz identyfikator, nazwę i ważność wszystkich wyzwalaczy w stanie problemu i posortuj je według ważności malejąco.

Żądanie:

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

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "13907",
            "description": "Procesy samomonitorowania Zabbix zajęte w mniej niż 100%",
            "priority": "4"
        },
        {
            "triggerid": "13824",
            "description": "Procesy discoverera Zabbix zajęte w więcej niż 75%",
            "priority": "3"
        }
    ],
    "id": 1
}

Pobieranie konkretnego wyzwalacza z tagami

Pobierz konkretny wyzwalacz z tagami.

Żądanie:

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

Odpowiedź:

{
    "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
}

Zobacz także

Źródło

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