triggerprototype.get

Opis

integer/array triggerprototype.get(object parameters)

Ta metoda umożliwia pobieranie prototypów wyzwalaczy zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w Rolach użytkowników.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
active flag Zwracaj tylko włączone prototypy wyzwalaczy należące do monitorowanych hostów.
discoveryids ID/array Zwracaj tylko prototypy wyzwalaczy należące do podanych reguł LLD.
functions string/array Zwracaj tylko wyzwalacze używające podanych funkcji.

Listę obsługiwanych funkcji można znaleźć na stronie Supported functions.
group string Zwracaj tylko prototypy wyzwalaczy należące do hostów lub szablonów z grup hostów lub grup szablonów o podanej nazwie.
groupids ID/array Zwracaj tylko prototypy wyzwalaczy należące do hostów lub szablonów z podanych grup hostów lub grup szablonów.
host string Zwracaj tylko prototypy wyzwalaczy należące do hostów o podanej nazwie.
hostids ID/array Zwracaj tylko prototypy wyzwalaczy należące do podanych hostów.
inherited boolean Jeśli ustawiono na true, zwracaj tylko prototypy wyzwalaczy dziedziczone z szablonu.
maintenance boolean Jeśli ustawiono na true, zwracaj tylko włączone prototypy wyzwalaczy należące do hostów w konserwacji.
min_severity integer Zwracaj tylko prototypy wyzwalaczy o ważności większej lub równej podanej ważności.
monitored flag Zwracaj tylko włączone prototypy wyzwalaczy należące do monitorowanych hostów i zawierające wyłącznie włączone pozycje.
templated boolean Jeśli ustawiono na true, zwracaj tylko prototypy wyzwalaczy należące do szablonów.
templateids ID/array Zwracaj tylko prototypy wyzwalaczy należące do podanych szablonów.
triggerids ID/array Zwracaj tylko prototypy wyzwalaczy o podanych identyfikatorach.
expandExpression flag Rozwiń funkcje i makra w wyrażeniu wyzwalacza.
selectDependencies query Zwracaj prototypy wyzwalaczy i wyzwalacze, od których zależy prototyp wyzwalacza, we właściwości dependencies.
selectDiscoveryData query Zwracaj właściwość discoveryData z danymi obiektu wykrywania prototypu wyzwalacza. Obiekt wykrywania prototypu wyzwalacza łączy wykryty prototyp wyzwalacza z prototypem wyzwalacza, z którego został wykryty.

Ma on następujące właściwości:
parent_triggerid - (ID) identyfikator prototypu wyzwalacza, z którego utworzono prototyp wyzwalacza;
status - (int) status wykrywania prototypu wyzwalacza:
0 - (domyślnie) prototyp wyzwalacza jest wykryty,
1 - prototyp wyzwalacza nie jest już wykrywany;
ts_delete - (timestamp) czas, kiedy prototyp wyzwalacza, który nie jest już wykrywany, zostanie usunięty;
ts_disable - (timestamp) czas, kiedy prototyp wyzwalacza, który nie jest już wykrywany, zostanie wyłączony;
disable_source - (int) wskaźnik określający, czy prototyp wyzwalacza został wyłączony przez regułę LLD czy ręcznie:
0 - (domyślnie) wyłączony automatycznie,
1 - wyłączony przez regułę LLD.
selectDiscoveryRule query Zwracaj regułę LLD, do której należy prototyp wyzwalacza, we właściwości discoveryRule.
selectDiscoveryRulePrototype query Zwracaj właściwość discoveryRulePrototype z nadrzędnym prototypem reguły LLD, do którego należy prototyp wyzwalacza.
selectFunctions query Zwracaj funkcje używane w prototypie wyzwalacza 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.
selectHostGroups query Zwracaj grupy hostów, do których należy prototyp wyzwalacza, we właściwości hostgroups.
selectHosts query Zwracaj hosty, do których należy prototyp wyzwalacza, we właściwości hosts.
selectInheritedTags query Zwracaj właściwość inheritedTags z tagami dziedziczonymi z szablonów, podłączonych szablonów i hostów oraz z prototypów pozycji, do których odwołują się wyrażenia wyzwalacza lub odtwarzania.
selectItems query Zwracaj pozycje i prototypy pozycji używane przez prototyp wyzwalacza we właściwości items.
selectTags query Zwracaj tagi prototypu wyzwalacza we właściwości tags.
selectTemplateGroups query Zwracaj grupy szablonów, do których należy prototyp wyzwalacza, we właściwości templategroups.
filter object Zwracaj tylko te wyniki, które dokładnie odpowiadają podanemu filtrowi.

Akceptuje obiekt, w którym kluczami są nazwy właściwości, a wartościami są pojedyncza wartość lub tablica wartości do dopasowania.

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

Obsługuje dodatkowe właściwości:
host - techniczna nazwa hosta, do którego należy prototyp wyzwalacza;
hostid - identyfikator 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, priority, discovered.
countOutput boolean Te parametry opisano w reference commentary.
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:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli użyto parametru countOutput.

Przykłady

Pobieranie prototypów wyzwalaczy z reguły LLD

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

Żądanie:

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

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "13272",
            "expression": "{12598}<20",
            "description": "Liczba wolnych i-węzłów jest mniejsza niż 20% na woluminie {#FSNAME}",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "",
            "error": "",
            "templateid": "0",
            "type": "0",
            "state": "0",
            "flags": "2",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "discover": "0",
            "event_name": "",
            "uuid": "6ce467d05e8745409a177799bed34bb3",
            "url_name": "",
            "functions": [
                {
                    "functionid": "12598",
                    "itemid": "22454",
                    "triggerid": "13272",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        },
        {
            "triggerid": "13266",
            "expression": "{13500}<20",
            "description": "Wolne miejsce na dysku jest mniejsze niż 20% na woluminie {#FSNAME}",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "",
            "error": "",
            "templateid": "0",
            "type": "0",
            "state": "0",
            "flags": "2",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "discover": "0",
            "event_name": "",
            "uuid": "74a1fc62bfe24b7eabe4e244c70dc384",
            "url_name": "",
            "functions": [
                {
                    "functionid": "13500",
                    "itemid": "22686",
                    "triggerid": "13266",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Pobieranie określonego prototypu wyzwalacza z tagami

Żądanie:

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

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17373",
            "description": "Wolne miejsce na dysku jest mniejsze niż 20% na woluminie {#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.