triggerprototype.get

Beschrijving

integer/array triggerprototype.get(objectparameters)

De methode maakt het mogelijk om trigger-prototypes op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter	Type	Beschrijving
active	flag	Alleen ingeschakelde trigger-prototypen retourneren die behoren tot bewaakte hosts.
discoveryids	string/array	Alleen trigger-prototypen retourneren die behoren tot de opgegeven LLD-regels.
functions	string/array	Alleen trigger-prototypen retourneren die de opgegeven functies gebruiken. Zie de pagina Ondersteunde functies voor een lijst met ondersteunde functies.
group	string	Alleen trigger-prototypen retourneren die behoren tot hosts uit de hostgroep met de opgegeven naam.
groupids	string/array	Alleen trigger-prototypen retourneren die behoren tot hosts uit de opgegeven hostgroepen.
host	string	Alleen trigger-prototypen retourneren die behoren tot hosts met de opgegeven naam.
hostids	string/array	Alleen trigger-prototypen retourneren die behoren tot de opgegeven hosts.
inherited	boolean	Indien ingesteld op `true`, alleen trigger-prototypen retourneren die zijn geërfd van een sjabloon.
maintenance	boolean	Indien ingesteld op `true`, alleen ingeschakelde trigger-prototypen retourneren die behoren tot hosts in onderhoud.
min_severity	integer	Alleen trigger-prototypen retourneren met ernst groter dan of gelijk aan de opgegeven ernst.
monitored	flag	Alleen ingeschakelde trigger-prototypen retourneren die behoren tot bewaakte hosts en alleen ingeschakelde items bevatten.
templated	boolean	Indien ingesteld op `true`, alleen trigger-prototypen retourneren die behoren tot sjablonen.
templateids	string/array	Alleen trigger-prototypen retourneren die behoren tot de opgegeven sjablonen.
triggerids	string/array	Alleen trigger-prototypen retourneren met de opgegeven IDs.
expandExpression	flag	Functies en macro's in de trigger-uitdrukking uitbreiden.
selectDependencies	query	Trigger-prototypen en triggers retourneren waar het trigger-prototype afhankelijk van is in de eigenschap `dependencies`.
selectDiscoveryRule	query	De LLD-regel retourneren waar het trigger-prototype bij hoort.
selectFunctions	query	Functies gebruikt in het trigger-prototype retourneren in de eigenschap `functions`. De functie-objecten vertegenwoordigen de functies die worden gebruikt in de trigger-uitdrukking en hebben de volgende eigenschappen: `functionid` - (string) ID van de functie; `itemid` - (string) ID van het item dat in de functie wordt gebruikt; `function` - (string) naam van de functie; `parameter` - (string) parameter die aan de functie wordt doorgegeven. Queryparameter wordt in de geretourneerde tekenreeks vervangen door het symbool `$`.
selectGroups	query	De hostgroepen retourneren waartoe het trigger-prototype behoort in de eigenschap groups.
selectHosts	query	De hosts retourneren waartoe het trigger-prototype behoort in de eigenschap hosts.
selectItems	query	Items en item-prototypes die worden gebruikt in het trigger-prototype retourneren in de eigenschap items.
selectTags	query	De tags van het trigger-prototype retourneren in de eigenschap tags.
filter	object	Alleen resultaten retourneren die exact overeenkomen met de opgegeven filter. <brAccepteert een array, waarbij de sleutels de eigenschapsnamen zijn en de waarden ofwel een enkele waarde ofwel een array van waarden zijn om mee te matchen. <brOndersteunt aanvullende filters: `host` - technische naam van de host waartoe het trigger-prototype behoort; `hostid` - ID van de host waartoe het trigger-prototype behoort.
limitSelects	integer	Beperkt het aantal records dat wordt geretourneerd door subselecties. <brVan toepassing op de volgende subselecties: `selectHosts` - resultaten worden gesorteerd op `host`.
sortfield	string/array	De resultaten sorteren op de opgegeven eigenschappen. <brMogelijke waarden zijn: `triggerid`, `description`, `status` en `priority`.
countOutput	boolean	Deze parameters, die gemeenschappelijk zijn voor alle `get`-methoden, worden in detail beschreven in het referentie-commentaar.
editable	boolean
excludeSearch	boolean
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Retourwaarden

(integer/array) Retourneert ofwel:

een reeks objecten;
het aantal opgehaalde objecten, als de parameter countOutput is gebruikt.

Voorbeelden

Trigger-prototypes ophalen uit een LLD-regel

Haal alle trigger-prototypes en hun functies op uit een LLD-regel.

Verzoek:

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

Antwoord:

{
           "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
       }

Een specifiek trigger-prototype ophalen met tags