Table of Contents
trigger.get
Beschrijving
integer/array trigger.get(object parameters)
De methode maakt het mogelijk om triggers 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 |
|---|---|---|
| triggerids | string/array | Retourneer alleen triggers met de opgegeven ID's. |
| groupids | string/array | Retourneer alleen triggers die behoren tot hosts van de gegeven hostgroepen. |
| templateids | string/array | Retourneer alleen triggers die bij de opgegeven sjablonen horen. |
| hostids | string/array | Retourneer alleen triggers die bij de opgegeven hosts horen. |
| itemids | string/array | Retourneer alleen triggers die de opgegeven items bevatten. |
| functions | string/array | Retourneer alleen triggers die de opgegeven functies gebruiken. Raadpleeg de pagina ondersteunde functie voor een lijst met ondersteunde functies. |
| group | string | Retourneer alleen triggers die behoren tot hosts van de hostgroep met de opgegeven naam. |
| host | string | Retourneer alleen triggers die bij de host horen met de opgegeven naam. |
| inherited | boolean | Indien ingesteld op true retourneert alleen triggers die zijn overgenomen van een sjabloon. |
| template | boolean | Indien ingesteld op true worden alleen triggers geretourneerd die bij sjablonen horen. |
| dependent | boolean | Indien ingesteld op true retourneert u alleen triggers die afhankelijkheden hebben. Indien ingesteld op false retourneert u alleen triggers die geen afhankelijkheden hebben. |
| monitored | flag | Retourneer alleen geactiveerde triggers die bij gecontroleerde hosts horen en alleen geactiveerde items bevatten. |
| active | flag | Retourneer alleen geactiveerde triggers die behoren tot gecontroleerde hosts. |
| maintenance | boolean | Indien ingesteld op true retourneer alleen geactiveerde triggers die behoren tot hosts in onderhoud. |
| withUnacknowledgedEvents | flag | Retourneer alleen triggers met niet-bevestigde gebeurtenissen. |
| withAcknowledgedEvents | flag | Retourneer alleen triggers met alle bevestigde gebeurtenissen. |
| withLastEventUnacknowledged | flag | Retourneer alleen triggers met de laatste gebeurtenis niet bevestigd. |
| skipDependent | flag | Sla triggers over in een probleemtoestand die afhankelijk zijn van andere triggers. Merk op dat de andere triggers worden genegeerd als ze zijn uitgeschakeld, items hebben uitgeschakeld of itemhosts hebben uitgeschakeld. |
| lastChangeSince | timestamp | Retourneer alleen triggers die hun status hebben gewijzigd na de opgegeven tijd. |
| lastChangeTill | timestamp | Retourneer alleen triggers die hun status hebben gewijzigd vóór de opgegeven tijd. |
| only_true | flag | Retourneer alleen triggers die zich recentelijk in een probleemsituatie bevonden. |
| min_severity | integer | Return alleen triggers met een ernst groter of gelijk aan de opgegeven ernst. |
| evaltype | integer | Regels voor het zoeken naar tags. Mogelijke waarden: 0 - (standaard) And/Or; 2 - Or. |
| tags | array of objects | Retourneer alleen triggers met opgegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelig of hoofdletterongevoelig zoeken op tagwaarde, afhankelijk van de operatorwaarde. Formaat: [{"tag": "<tag>", "value": "<value>", " operator": "<operator>"}, ...].Een lege array retourneert alle triggers. Mogelijke typen operatoren: 0 - (standaard) Like; 1 - Gelijk; 2 - Niet zoals; 3 - Niet gelijk 4 - Bestaat; 5 - Bestaat niet. |
| expandComment | flag | Macro's uitvouwen in de triggerbeschrijving. |
| expandDescription | flag | Macro's uitvouwen in de naam van de trigger. |
| expandExpression | flag | Breid functies en macro's uit in de trigger-expressie. |
| selectGroups | query | Retourneer de hostgroepen waartoe de trigger behoort in de eigenschap groups. |
| selectHosts | query | Retourneer de hosts waartoe de trigger behoort in de eigenschap hosts. |
| selectItems | query | Retourneert items die zijn opgenomen door de trigger in de eigenschap items. |
| selectFunctions | query | Retourneert functies die worden gebruikt in de trigger in de eigenschap functions.De functie-objecten vertegenwoordigen de functies die in de trigger-expressie worden gebruikt 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 doorgegeven aan de functie. De queryparameter wordt vervangen door het $-symbool in de geretourneerde tekenreeks. |
| selectDependencies | query | Retourtriggers waarvan de trigger afhangt in de eigenschap dependencies. |
| selectDiscoveryRule | query | Retourneer de detectieregel op laag niveau die de trigger heeft gemaakt. |
| selectLastEvent | query | Retourneert de laatste significante triggergebeurtenis in de eigenschap lastEvent. |
| selectTags | query | Retourneer de trigger-tags in de eigenschap tags. |
| selectTriggerDiscovery | query | Retourneer het trigger discovery-object in de eigenschap triggerDiscovery'. De trigger discovery-objecten koppelen de trigger aan een trigger-prototype waaruit het is gemaakt.parent_triggerid-(string)ID van het trigger-prototype waarvan de trigger is gemaakt.| |filter|object|Retourneert alleen die resultaten die exact overeenkomen met het opgegeven filter.host- technische naam van de host waartoe de trigger behoort;hostid- ID van de host waartoe de trigger behoort.| |limitSelects|integer|Beperkt het aantal records dat wordt geretourneerd door subselecties.selectHosts- resultaten worden gesorteerd ophost.| |sortfield|string/array|[Sorteren](/manual/api/reference_commentary#common_get_method_parameters) het resultaat door de gegeven eigenschappen.triggerid,description,status, prioriteit,laatste wijzigingenhostnaam.| |countOutput|boolean|Deze parameters gelden voor alleget`-methoden en worden in detail beschreven op de pagina referentiecommentaar. |
| editable | booleaans | |
| excludeSearch | boolean | |
| limiet | geheel getal | |
| uitvoer | query | |
| preservekeys | boolean | |
| zoeken | object | |
| searchByAny | boolean | |
| searchWildcardsIngeschakeld | boolean | |
| sortorde | string/array | |
| startZoeken | booleaans |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Gegevens ophalen op trigger-ID
Haal alle gegevens en de functies op die worden gebruikt in trigger "14062".
Verzoek:
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"triggerids": "14062",
"output": "extend",
"selectFunctions": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"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
}Ophalen van triggers in probleemstatus
Haal de ID, naam en ernst op van alle triggers in de probleemstatus en sorteer ze op ernst in aflopende volgorde.
Verzoek:
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"output": [
"triggerid",
"description",
"priority"
],
"filter": {
"value": 1
},
"sortfield": "priority",
"sortorder": "DESC"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"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
}Een specifieke trigger ophalen met tags
Haal een specifieke trigger op met tags.
Verzoek:
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"output": [
"triggerid",
"description"
],
"selectTags": "extend",
"triggerids": [
"17578"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"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
}Zie ook
Bron
CTrigger::get() in ui/include/classes/api/services/CTrigger.php.