You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

trigger.get

Beschrijving

integer/array trigger.get(object parameters)

Deze methode maakt het mogelijk om triggers op te halen aan de hand van de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode op te roepen kan worden ingetrokken in de instellingen van gebruikersrollen. Zie Gebruikersrollen voor meer informatie.

Parameters

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

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
triggerids string/array Geef alleen triggers terug met de opgegeven IDs.
groupids string/array Geef alleen triggers terug die behoren tot hosts of sjablonengroepen uit de opgegeven hostgroepen of sjablonengroepen.
templateids string/array Geef alleen triggers terug die behoren tot de opgegeven sjablonen.
hostids string/array Geef alleen triggers terug die behoren tot de opgegeven hosts.
itemids string/array Geef alleen triggers terug die de opgegeven items bevatten.
functions string/array Geef alleen triggers terug die de opgegeven functies gebruiken.

Zie de ondersteunde functies pagina voor een lijst van ondersteunde functies.
group string Geef alleen triggers terug die behoren tot hosts of sjablonen uit de hostgroep of sjablonengroep met de opgegeven naam.
host string Geef alleen triggers terug die behoren tot een host met de opgegeven naam.
inherited boolean Indien ingesteld op true, geef alleen triggers terug die overgenomen zijn van een sjabloon.
templated boolean Indien ingesteld op true, geef alleen triggers terug die behoren tot sjablonen.
dependent boolean Indien ingesteld op true, geef alleen triggers terug die afhankelijkheden hebben. Indien ingesteld op false, geef alleen triggers terug die geen afhankelijkheden hebben.
monitored flag Geef alleen ingeschakelde triggers terug die behoren tot gemonitorde hosts en alleen ingeschakelde items bevatten.
active flag Geef alleen ingeschakelde triggers terug die behoren tot gemonitorde hosts.
maintenance boolean Indien ingesteld op true, geef alleen ingeschakelde triggers terug die behoren tot hosts in onderhoud.
withUnacknowledgedEvents flag Geef alleen triggers terug die onbevestigde gebeurtenissen hebben.
withAcknowledgedEvents flag Geef alleen triggers terug met alle gebeurtenissen bevestigd.
withLastEventUnacknowledged flag Geef alleen triggers terug waarbij de laatste gebeurtenis niet bevestigd is.
skipDependent flag Sla triggers in een probleemstaat over die afhankelijk zijn van andere triggers. Houd er rekening mee dat andere triggers genegeerd worden als ze uitgeschakeld zijn, uitgeschakelde items hebben of hosts met uitgeschakelde items hebben.
lastChangeSince timestamp Geef alleen triggers terug die hun status hebben gewijzigd na het opgegeven tijdstip.
lastChangeTill timestamp Geef alleen triggers terug die hun status hebben gewijzigd voor het opgegeven tijdstip.
only_true flag Geef alleen triggers terug die recentelijk in een probleemstaat zijn geweest.
min_severity integer Geef alleen triggers terug met een ernst groter dan of gelijk aan de opgegeven ernst.
evaltype integer Regels voor tag-zoeken.

Mogelijke waarden:
0 - (standaard) En/Of;
2 - Of.
tags array van objecten Geef alleen triggers terug met de opgegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelige of hoofdletteronafhankelijke zoekopdracht op tag-waarde afhankelijk van de operatorwaarde.
Opmaak: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Een lege array geeft alle triggers terug.

Mogelijke operatortypen:
0 - (standaard) Zoals;
1 - Gelijk;
2 - Niet zoals;
3 - Niet gelijk;
4 - Bestaat;
5 - Niet bestaat.
expandComment flag Vul macro's in de triggerbeschrijving uit.
expandDescription flag Vul macro's in de naam van de trigger uit.
expandExpression flag Vul functies en macro's in de triggerexpressie uit.
selectHostGroups query Geef de hostgroepen terug waar de trigger bij hoort in de hostgroups eigenschap.
selectHosts query Geef de hosts terug waar de trigger bij hoort in de hosts eigenschap.
selectItems query Geef items terug die door de trigger worden bevat in de items eigenschap.
selectFunctions query Geef de functies terug die in de trigger worden gebruikt in de functions eigenschap.

De functieobjecten vertegenwoordigen de functies die in de triggerexpressie 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 in de geretourneerde string vervangen door het $ symbool.
selectDependencies query Geef triggers terug waar de trigger afhankelijk van is in de dependencies eigenschap.
selectDiscoveryRule query Geef de ontdekkingsregel op laag niveau terug die de trigger heeft gemaakt.
selectLastEvent query Geef het laatste significante gebeurtenis van de trigger terug in de lastEvent eigenschap.
selectTags query Geef de trigger tags terug in de tags eigenschap.
selectTemplateGroups query Geef de sjablonengroepen terug waar de trigger bij hoort in de templategroups eigenschap.
selectTriggerDiscovery query Geef het triggerontdekkingobject terug in de triggerDiscovery eigenschap. De triggerontdekkingobjecten linken de trigger aan een triggerprototype waaruit deze is gemaakt.

Het heeft de volgende eigenschappen:
parent_triggerid - (string) ID van het triggerprototype waaruit de trigger is gemaakt.
filter object Geef alleen resultaten terug die exact overeenkomen met de opgegeven filter.
<brAccepteert een array, waarbij de sleutels eigenschapsnamen zijn en de waarden ofwel een enkele waarde of een array van waarden zijn om tegen te vergelijken.
<brOndersteunt aanvullende filters:
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 teruggegeven door subselecties.
<brVan toepassing op de volgende subselecties:
selectHosts - resultaten worden gesorteerd op host.
sortfield string/array Sorteer de resultaten op de opgegeven eigenschappen.
<brMogelijke waarden: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Deze parameters die gemeenschappelijk zijn voor alle get-methoden, worden in detail beschreven op de verwijzing naar commentaar pagina.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(verouderd)
query Deze parameter is verouderd, gebruik in plaats daarvan selectHostGroups of selectTemplateGroups.
Geef de hostgroepen en sjablonengroepen terug waar de trigger bij hoort in de groups eigenschap.

Retourwaarden

(integer/array) Geeft ofwel:

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

Voorbeelden

Gegevens ophalen op basis van trigger-ID

Haal alle gegevens en de gebruikte functies op voor trigger "14062".

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "trigger.get",
           "params": {
               "triggerids": "14062",
               "output": "extend",
               "selectFunctions": "extend"
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "14062",
                   "expression": "{13513}<10m",
                   "description": "{HOST.NAME} is opnieuw opgestart (uptime < 10m)",
                   "url": "",
                   "status": "0",
                   "value": "0",
                   "priority": "2",
                   "lastchange": "0",
                   "comments": "De host-uptime is minder dan 10 minuten",
                   "error": "",
                   "templateid": "10016",
                   "type": "0",
                   "state": "0",
                   "flags": "0",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "event_name": "",
                   "uuid": "",
                   "url_name": "",
                   "functions": [
                       {
                           "functionid": "13513",
                           "itemid": "24350",
                           "triggerid": "14062",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               }
           ],
           "id": 1
       }

Triggers in probleemtoestand ophalen

Haal de ID, naam en ernst van alle triggers in de probleemtoestand op en sorteer ze op ernst in aflopende volgorde.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "trigger.get",
           "params": {
               "output": [
                   "triggerid",
                   "description",
                   "priority"
               ],
               "filter": {
                   "value": 1
               },
               "sortfield": "priority",
               "sortorder": "DESC"
           },
           "id": 1
       }

Reactie:

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

Aanvraag:

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

Reactie:

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