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 | ´Ü·É°ù¨®? tylko wyzwalacze o podanych identyfikatorach. |
| groupids | string/array | ´Ü·É°ù¨®? tylko wyzwalacze nale??ce do host¨®w z podanych grup host¨®w. |
| templateids | string/array | ´Ü·É°ù¨®? tylko wyzwalacze nale??ce do podanych szablon¨®w. |
| hostids | string/array | ´Ü·É°ù¨®? tylko wyzwalacze nale??ce do podanych host¨®w. |
| itemids | string/array | ´Ü·É°ù¨®? tylko wyzwalacze zawieraj?ce podane pozycje. |
| functions | string/array | ´Ü·É°ù¨®? tylko wyzwalacze korzystaj?ce z podanych funkcji. Odwied? stron? obs?ugiwanych funkcji dla listy obs?ugiwanych funkcji. |
| group | string | ´Ü·É°ù¨®? tylko wyzwalacze nale??ce do host¨®w z grupy host¨®w o podanej nazwie. |
| host | string | ´Ü·É°ù¨®? 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 | ´Ü·É°ù¨®? tylko w??czone wyzwalacze nale??ce do monitorowanych host¨®w i zawieraj?ce tylko w??czone pozycje. |
| active | flag | ´Ü·É°ù¨®? 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 | ´Ü·É°ù¨®? tylko wyzwalacze posiadaj?ce niepotwierdzone zdarzenia. |
| withAcknowledgedEvents | flag | ´Ü·É°ù¨®? tylko wyzwalacze z wszystkimi zdarzeniami potwierdzonymi. |
| withLastEventUnacknowledged | flag | ´Ü·É°ù¨®? 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 | ´Ü·É°ù¨®? tylko wyzwalacze, kt¨®re zmieni?y sw¨®j stan po podanym czasie. |
| lastChangeTill | timestamp | ´Ü·É°ù¨®? tylko wyzwalacze, kt¨®re zmieni?y sw¨®j stan przed podanym czasem. |
| only_true | flag | ´Ü·É°ù¨®? tylko wyzwalacze, kt¨®re niedawno znajdowa?y si? w stanie problem. |
| min_severity | integer | ´Ü·É°ù¨®? 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 | ´Ü·É°ù¨®? 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 | ´Ü·É°ù¨®? grupy host¨®w, do kt¨®rych nale?y wyzwalacz w w?a?ciwo?ci groups. |
| selectHosts | query | ´Ü·É°ù¨®? hosty, do kt¨®rych nale?y wyzwalacz w w?a?ciwo?ci hosts. |
| selectItems | query | ´Ü·É°ù¨®? pozycje zawarte przez wyzwalacz w w?a?ciwo?ci items. |
| selectFunctions | query | ´Ü·É°ù¨®? 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 | ´Ü·É°ù¨®? wyzwalacze, od kt¨®rych zale?y wyzwalacz w w?a?ciwo?ci dependencies. |
| selectDiscoveryRule | query | ´Ü·É°ù¨®? regu?? wykrywania niskopoziomowego, kt¨®ra utworzy?a wyzwalacz. |
| selectLastEvent | query | ´Ü·É°ù¨®? ostatnie istotne zdarzenie wyzwalacza w w?a?ciwo?ci lastEvent. |
| selectTags | query | ´Ü·É°ù¨®? znaczniki wyzwalacza w w?a?ciwo?ci tags. |
| selectTriggerDiscovery | query | ´Ü·É°ù¨®? 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 | ´Ü·É°ù¨®? 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": "Áú»¢¶Ä²© self-monitoring processes < 100% busy",
"priority": "4"
},
{
"triggerid": "13824",
"description": "Áú»¢¶Ä²© 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
?°ù¨®»å?´Ç
CTrigger::get() w ui/include/classes/api/services/CTrigger.php.