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 żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
triggerids ID/array Zwraca tylko wyzwalacze o podanych identyfikatorach.
groupids ID/array Zwraca tylko wyzwalacze należące do hostów lub szablonów z podanych grup hostów lub grup szablonów.
templateids ID/array Zwraca tylko wyzwalacze należące do podanych szablonów.
hostids ID/array Zwraca tylko wyzwalacze należące do podanych hostów.
itemids ID/array Zwraca tylko wyzwalacze zawierające podane pozycje.
maintenanceids ID/array Zwraca tylko wyzwalacze, na które wpływają podane okresy utrzymania.
functions string/array Zwraca tylko wyzwalacze używające podanych funkcji.

Lista obsługiwanych funkcji znajduje się na stronie obsługiwanych funkcji.
group string Zwraca tylko wyzwalacze należące do hostów lub szablonów z grupy hostów lub grupy szablonów o podanej nazwie.
host string Zwraca tylko wyzwalacze należące do hosta o podanej nazwie technicznej.
inherited boolean Jeśli ustawiono true, zwraca tylko wyzwalacze odziedziczone z szablonu.
templated boolean Jeśli ustawiono true, zwraca tylko wyzwalacze należące do szablonów.
dependent boolean Jeśli ustawiono true, zwraca tylko wyzwalacze mające zależności. Jeśli ustawiono false, zwraca tylko wyzwalacze niemające zależności.
monitored flag Zwraca tylko włączone wyzwalacze należące do monitorowanych hostów i zawierające wyłącznie włączone pozycje.
active flag Zwraca tylko włączone wyzwalacze należące do monitorowanych hostów.
maintenance boolean Jeśli ustawiono true, zwraca tylko włączone wyzwalacze należące do hostów objętych okresem utrzymania.
withUnacknowledgedEvents flag Zwraca tylko wyzwalacze mające niepotwierdzone zdarzenia.
withAcknowledgedEvents flag Zwraca tylko wyzwalacze, których wszystkie zdarzenia zostały potwierdzone.
withLastEventUnacknowledged flag Zwraca tylko wyzwalacze, których ostatnie zdarzenie nie zostało potwierdzone.
skipDependent flag Pomija wyzwalacze w stanie problemu, które zależą od innych wyzwalaczy. Należy pamiętać, że inne wyzwalacze są ignorowane, jeśli są wyłączone, mają wyłączone pozycje lub należą do hostów z wyłączonymi pozycjami.
lastChangeSince timestamp Zwraca tylko wyzwalacze, które zmieniły stan po podanym czasie.
lastChangeTill timestamp Zwraca tylko wyzwalacze, które zmieniły stan przed podanym czasem.
only_true flag Zwraca tylko wyzwalacze, które niedawno znajdowały się w stanie problemu (w obrębie ok_period).
min_severity integer Zwraca tylko wyzwalacze o ważności większej lub równej podanej ważności.
evaltype integer Metoda oceny tagów.

Możliwe wartości:
0 - (domyślnie) And/Or;
2 - Or.
tags array Zwraca tylko wyzwalacze z podanymi tagami.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Pusta tablica zwraca wszystkie wyzwalacze.

Możliwe wartości operatora:
0 - (domyślnie) Zawiera;
1 - Jest równe;
2 - Nie zawiera;
3 - Nie jest równe;
4 - Istnieje;
5 - Nie istnieje.
expandComment flag Rozwija makra w opisie wyzwalacza.
expandDescription flag Rozwija makra w nazwie wyzwalacza.
expandExpression flag Rozwija funkcje i makra w wyrażeniu wyzwalacza.
selectHostGroups query Zwraca grupy hostów, do których należy wyzwalacz, we właściwości hostgroups.
selectHosts query Zwraca hosty, do których należy wyzwalacz, we właściwości hosts.
selectItems query Zwraca pozycje zawarte w wyzwalaczu we właściwości items.
selectFunctions query Zwraca funkcje używane w wyzwalaczu we 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) identyfikator funkcji;
itemid - (ID) identyfikator pozycji użytej w funkcji;
function - (string) nazwa funkcji;
parameter - (string) parametr przekazany do funkcji. Parametr zapytania jest zastępowany symbolem $ w zwracanym ciągu.
selectDependencies query Zwraca wyzwalacze, od których zależy dany wyzwalacz, we właściwości dependencies.
selectDiscoveryData query Zwraca właściwość discoveryData zawierającą dane obiektu wykrywania wyzwalacza. Obiekt wykrywania wyzwalacza łączy wykryty wyzwalacz z prototypem wyzwalacza, na podstawie którego został wykryty.

Ma następujące właściwości:
parent_triggerid - (ID) identyfikator prototypu wyzwalacza, na podstawie którego utworzono wyzwalacz;
status - (int) stan wykrywania wyzwalacza:
0 - (domyślnie) 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 określający, czy wyzwalacz został wyłączony przez regułę LLD, czy ręcznie:
0 - (domyślnie) wyłączony automatycznie,
1 - wyłączony przez regułę LLD.
selectDiscoveryRule query Zwraca regułę wykrywania niskopoziomowego, która utworzyła wyzwalacz, we właściwości discoveryRule.
selectLastEvent query Zwraca ostatnie istotne zdarzenie wyzwalacza we właściwości lastEvent.
selectTags query Zwraca tagi wyzwalacza we właściwości tags.
inheritedTags boolean Zwraca wyzwalacze, które mają podane tags również w szablonie/hoście/połączonych szablonach.

Możliwe wartości:
true - szablon/host/połączone szablony również muszą mieć podane tagi;
false - (domyślnie) tagi z szablonu/hosta/połączonych szablonów są ignorowane.
selectInheritedTags query Zwraca właściwość inheritedTags zawierającą tagi odziedziczone z szablonów, połączonych szablonów i hostów oraz z pozycji, do których odwołują się wyrażenia problemu lub odzyskiwania wyzwalacza.
selectTemplateGroups query Zwraca grupy szablonów, do których należy wyzwalacz, we właściwości templategroups.
filter object Zwraca tylko wyniki dokładnie pasujące do podanego filtra.

Przyjmuje obiekt, w którym kluczami są nazwy właściwości, a wartościami pojedyncza wartość lub tablica wartości, z którymi należy porównać wyniki.

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 - identyfikator hosta, do którego należy wyzwalacz.
limitSelects integer Ogranicza liczbę rekordów zwracanych przez podzapytania.

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

Możliwe wartości: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Parametry te opisano w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectTriggerDiscovery query Zwraca obiekt wykrywania wyzwalacza we właściwości triggerDiscovery. Obiekty wykrywania wyzwalaczy łączą wyzwalacz z prototypem wyzwalacza, na podstawie którego został utworzony.

To zapytanie jest przestarzałe. Zamiast niego należy użyć 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żywane 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",
                    "triggerid": "14062",
                    "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 określonego wyzwalacza z tagami

Pobierz określony 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\")}",
                    "automatic": "1"
                },
                {
                    "tag": "error",
                    "value": "",
                    "automatic": "1"
                }
            ]
        }
    ],
    "id": 1
}

Zobacz także

Źródło

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