Documentation
Table of Contents
trigger.get
Opis
integer/array trigger.get(object parameters)
Ta metoda pozwala na pobieranie wyzwalaczy zgodnie z podanymi parametrami.
Metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody można wyłączyć w ustawieniach ról użytkowników. Zobacz Role użytkowników po więcej informacji.
Parametry
(object) Parametry definiujące pożądany wynik.
Metoda obsługuje następujące parametry.
| Parametr | Typ | Opis |
|---|---|---|
| triggerids | string/array | Zwróć tylko wyzwalacze o podanych identyfikatorach. |
| groupids | string/array | Zwróć tylko wyzwalacze należące do hostów z podanych grup hostów. |
| templateids | string/array | Zwróć tylko wyzwalacze należące do podanych szablonów. |
| hostids | string/array | Zwróć tylko wyzwalacze należące do podanych hostów. |
| itemids | string/array | Zwróć tylko wyzwalacze zawierające podane pozycje. |
| functions | string/array | Zwróć tylko wyzwalacze korzystające z podanych funkcji. Odwiedź stronę obsługiwanych funkcji dla listy obsługiwanych funkcji. |
| group | string | Zwróć tylko wyzwalacze należące do hostów z grupy hostów o podanej nazwie. |
| host | string | Zwróć tylko wyzwalacze należące do hosta o podanej nazwie technicznej. |
| inherited | boolean | Jeśli ustawione na true, zwróć tylko wyzwalacze odziedziczone po szablonie. |
| templated | boolean | Jeśli ustawione na true, zwróć tylko wyzwalacze należące do szablonów. |
| dependent | boolean | Jeśli ustawione na true, zwróć tylko wyzwalacze posiadające zależności. Jeśli ustawione na false, zwróć tylko wyzwalacze nieposiadające zależności. |
| monitored | flag | Zwróć tylko włączone wyzwalacze należące do monitorowanych hostów i zawierające tylko włączone pozycje. |
| active | flag | Zwróć tylko włączone wyzwalacze należące do monitorowanych hostów. |
| maintenance | boolean | Jeśli ustawione na true, zwróć tylko włączone wyzwalacze należące do hostów w stanie utrzymania. |
| withUnacknowledgedEvents | flag | Zwróć tylko wyzwalacze posiadające niepotwierdzone zdarzenia. |
| withAcknowledgedEvents | flag | Zwróć tylko wyzwalacze z wszystkimi zdarzeniami potwierdzonymi. |
| withLastEventUnacknowledged | flag | Zwróć tylko wyzwalacze z ostatnim zdarzeniem niepotwierdzonym. |
| skipDependent | flag | Pomiń wyzwalacze w stanie problem, które zależą od innych wyzwalaczy. Zauważ, że inne wyzwalacze są ignorowane, jeśli są wyłączone, mają wyłączone pozycje lub wyłączone hosty pozycji. |
| lastChangeSince | timestamp | Zwróć tylko wyzwalacze, które zmieniły swój stan po podanym czasie. |
| lastChangeTill | timestamp | Zwróć tylko wyzwalacze, które zmieniły swój stan przed podanym czasem. |
| only_true | flag | Zwróć tylko wyzwalacze, które niedawno znajdowały się w stanie problem. |
| min_severity | integer | Zwróć tylko wyzwalacze z poziomem większym lub równym podanemu poziomowi. |
| evaltype | integer | Zasady wyszukiwania znaczników. Możliwe wartości: 0 - (domyślnie) I/Lub; 2 - Lub. |
| tags | array of objects | Zwróć tylko wyzwalacze z podanymi znacznikami. Dokładne dopasowanie według tagu i przeszukiwanie według wartości znacznika w zależności od wartości operatora. Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Pusta tablica zwraca wszystkie wyzwalacze. Możliwe typy operatorów: 0 - (domyślnie) Zawiera; 1 - Jest równy; 2 - Nie zawiera; 3 - Nie jest równy; 4 - Istnieje; 5 - Nie istnieje. |
| expandComment | flag | Rozwiń makra w opisie wyzwalacza. |
| expandDescription | flag | Rozwiń makra w nazwie wyzwalacza. |
| expandExpression | flag | Rozwiń funkcje i makra w wyrażeniu wyzwalacza. |
| selectGroups | query | Zwróć grupy hostów, do których należy wyzwalacz w właściwości groups. |
| selectHosts | query | Zwróć hosty, do których należy wyzwalacz w właściwości hosts. |
| selectItems | query | Zwróć pozycje zawarte przez wyzwalacz w właściwości items. |
| selectFunctions | query | Zwróć 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 - (string) ID funkcji;itemid - (string) ID pozycji użytej w funkcji;function - (string) nazwa funkcji;parameter - (string) parametr przekazany do funkcji. Parametr zapytania jest zastępowany symbolem $ w zwróconym ciągu znaków. |
| selectDependencies | query | Zwróć wyzwalacze, od których zależy wyzwalacz w właściwości dependencies. |
| selectDiscoveryRule | query | Zwróć regułę wykrywania niskopoziomowego, która utworzyła wyzwalacz. |
| selectLastEvent | query | Zwróć ostatnie istotne zdarzenie wyzwalacza w właściwości lastEvent. |
| selectTags | query | Zwróć znaczniki wyzwalacza w właściwości tags. |
| selectTriggerDiscovery | query | Zwróć obiekt wykrycia wyzwalacza w właściwości triggerDiscovery. Obiekty wykrycia wyzwalacza łączy wyzwalacz z prototypem wyzwalacza, z którego został utworzony.Posiada następujące właściwości: parent_triggerid - (string) ID prototypu wyzwalacza, z którego został utworzony wyzwalacz. |
| filter | object | Zwróć tylko te wyniki, które dokładnie pasują do podanego filtru. Przyjmuje tablicę, gdzie klucze to nazwy właściwości, a wartości to pojedyncza wartość lub tablica wartości do dopasowania. Obsługuje dodatkowe filtry: 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 podzapytanie. Dotyczy następujących podzapytań: selectHosts - wyniki będą sortowane według host. |
| sortfield | string/array | Sortuj wyniki według podanych właściwości. Możliwe wartości to: triggerid, description, status, priority, lastchange i hostname. |
| countOutput | boolean | Te parametry, które są wspólne dla wszystkich metod get, są opisane szczegółowo na stronie komentarza referencyjnego. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Zwracane wartości
(integer/array) Zwraca jedną z opcji:
- tablicę obiektów;
- liczbę pobranych obiektów, jeśli parametr
countOutputzostał wykorzystany.
Przykłady
Pobieranie danych według identyfikatora wyzwalacza
Pobierz wszystkie dane i funkcje używane w wyzwalaczu "14062".
Zapytanie:
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"triggerids": "14062",
"output": "extend",
"selectFunctions": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"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": "",
"functions": [
{
"functionid": "13513",
"itemid": "24350",
"triggerid": "14062",
"parameter": "$",
"function": "last"
}
]
}
],
"id": 1
}Pobieranie wyzwalaczy w stanie problem
Pobierz identyfikator, nazwę i poziom wszystkich wyzwalaczy w stanie problem i posortuj je według poziomu w kolejności malejącej.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"output": [
"triggerid",
"description",
"priority"
],
"filter": {
"value": 1
},
"sortfield": "priority",
"sortorder": "DESC"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowiedź:
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "13907",
"description": "Zabbix self-monitoring processes < 100% busy",
"priority": "4"
},
{
"triggerid": "13824",
"description": "Zabbix discoverer processes more than 75% busy",
"priority": "3"
}
],
"id": 1
}Pobieranie konkretnego wyzwalacza z znacznikami
Pobierz konkretny wyzwalacz wraz z znacznikami.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"output": [
"triggerid",
"description"
],
"selectTags": "extend",
"triggerids": [
"17578"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"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.