triggerprototype.get

Opis

integer/array triggerprototype.get(object parameters)

Metoda umożliwia pobranie prototypów 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
active flag Zwróć tylko aktywne prototypy wyzwalaczy, które należą do monitorowanych hostów.
discoveryids string/array Zwróć tylko prototypy wyzwalaczy, które należą do określonych reguł LLD.
functions string/array Zwróć tylko wyzwalacze, które używają określonych funkcji.

Odwiedź Stronę z obsługiwanymi funkcjami dla listy obsługiwanych funkcji.
group string Zwróć tylko prototypy wyzwalaczy, które należą do hostów z grupami o podanej nazwie.
groupids string/array Zwróć tylko prototypy wyzwalaczy, które należą do hostów z podanych grup hostów.
host string Zwróć tylko prototypy wyzwalaczy, które należą do hostów o podanej nazwie.
hostids string/array Zwróć tylko prototypy wyzwalaczy, które należą do określonych hostów.
inherited boolean Jeśli ustawione na true, zwróć tylko prototypy wyzwalaczy odziedziczone z szablonu.
maintenance boolean Jeśli ustawione na true, zwróć tylko aktywne prototypy wyzwalaczy, które należą do hostów w stanie utrzymania.
min_severity integer Zwróć tylko prototypy wyzwalaczy o pooziomie większym lub równym określonemu poziomowi.
monitored flag Zwróć tylko aktywne prototypy wyzwalaczy, które należą do monitorowanych hostów i zawierają tylko aktywne pozycje.
templated boolean Jeśli ustawione na true, zwróć tylko prototypy wyzwalaczy, które należą do szablonów.
templateids string/array Zwróć tylko prototypy wyzwalaczy, które należą do podanych szablonów.
triggerids string/array Zwróć tylko prototypy wyzwalaczy o podanych ID.
expandExpression flag Rozwiń funkcje i makra w wyrażeniu wyzwalacza.
selectDependencies query Zwróć prototypy wyzwalaczy i wyzwalacze, od których zależy prototyp wyzwalaczy, w właściwości dependencies.
selectDiscoveryRule query Zwróć regułę LLD, do której należy prototyp wyzwalaczy.
selectFunctions query Zwróć funkcje używane w prototypie wyzwalacza 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 elementu używanego w funkcji;
function - (string) nazwa funkcji;
parameter - (string) parametr przekazywany do funkcji. Parametr zapytania jest zastępowany symbolem $ w zwróconym łańcuchu.
selectGroups query Zwróć grupy hostów, do których należy prototyp wyzwalaczy, w właściwości groups.
selectHosts query Zwróć hosty, do których należy prototyp wyzwalaczy, w właściwości hosts.
selectItems query Zwróć pozycje i prototypy pozycji używane w prototypie wyzwalaczy w właściwości items.
selectTags query Zwróć znaczniki prototypu wyzwalacza w właściwości tags.
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, które mają być porównane.

Obsługuje dodatkowe filtry:
host - nazwa techniczna hosta, do którego należy prototyp wyzwalacza;
hostid - ID hosta, do którego należy prototyp wyzwalacza.
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 i priority.
countOutput boolean Te parametry są wspólne dla wszystkich metod get i zostały 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 countOutput został wykorzystany.

Przykłady

Pobieranie prototypów wyzwalaczy z reguły LLD

Pobierz wszystkie prototypy wyzwalaczy i ich funkcje z reguły LLD.

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "triggerprototype.get",
           "params": {
               "output": "extend",
               "selectFunctions": "extend",
               "discoveryids": "22450"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "13272",
                   "expression": "{12598}<20",
                   "description": "Free inodes is less than 20% on volume {#FSNAME}",
                   "url": "",
                   "status": "0",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "functions": [
                       {
                           "functionid": "12598",
                           "itemid": "22454",
                           "triggerid": "13272",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               },
               {
                   "triggerid": "13266",
                   "expression": "{13500}<20",
                   "description": "Free disk space is less than 20% on volume {#FSNAME}",
                   "url": "",
                   "status": "0",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "functions": [
                       {
                           "functionid": "13500",
                           "itemid": "22686",
                           "triggerid": "13266",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               }
           ],
           "id": 1
       }

Pobieranie określonego prototypu wyzwalacza z znacznikami

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "triggerprototype.get",
           "params": {
               "output": [
                   "triggerid",
                   "description"
               ],
               "selectTags": "extend",
               "triggerids": [
                   "17373"
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "17373",
                   "description": "Free disk space is less than 20% on volume {#FSNAME}",
                   "tags": [
                       {
                           "tag": "volume",
                           "value": "{#FSNAME}"
                       },
                       {
                           "tag": "type",
                           "value": "{#FSTYPE}"
                       }
                   ]
               }
           ],
           "id": 1
       }

Zobacz także

Źródło

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