Documentation
Table of Contents
trigger.get
Descripció
integer/array trigger.get(object parameters)
El mètode permet recuperar triggers segons els paràmetres proveïts.
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paràmetres
(object) Paràmetres definint la sortida esperada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| triggerids | string/array | Retorna només triggers amb els identificadors donats. |
| groupids | string/array | Retorna només triggers que pertanyen als equips dels grups d'equips donats. |
| templateids | string/array | Retorna només triggers que pertanyen a les plantilles donades. |
| hostids | string/array | Retorna només triggers que pertanyen als equips donats. |
| itemids | string/array | Retorna només triggers que contenen els elements donats. |
| functions | string/array | Retorna només triggers que empren les funcions donades. Consulteu la pàgina funcions de triggers admeses per obtindre una llista de funcions admeses. |
| group | string | Retorna només triggers que pertanyen als equips del grup d'equips amb el nom donat. |
| host | string | Retorna només triggers pertanyents a l'equip amb el nom tècnic donat. |
| inherited | boolean | Si es defineix com a true, només retorna triggers heretats d'una plantilla. |
| template | boolean | Si s'estableix a true, només retorna triggers que pertanyen a plantilles. |
| dependent | boolean | Si s'estableix a true, només retorna triggers que tenen dependències. Si s'estableix a fals', només retorna triggers que no tenen dependències.| |monitored|flag|Retorna només triggers activats que pertanyen als equips monitorats i que només contenen elements activats.| |active|flag|Retorna només triggers activats que pertanyen als equips monitorats.| |maintenance|boolean|Si s'estableix atrue, només retorna triggers activats que pertanyen als equips en manteniment.| |withUnacknowledgedEvents|flag|Retorna només triggers que tenen esdeveniments no reconeguts.| |withAcknowledgedEvents|flag|Retorna només triggers amb tots els esdeveniments reconeguts.| |withLastEventUnacknowledged|flag|Retorna només triggers amb el darrer esdeveniment no reconegut.| |skipDependent|flag|Omet els triggers en un estat problemàtic que depenen d'altres triggers. Tingueu en compte que altres triggers s'ignoren si són desactivats, tenen elements desactivats o tenen equips d'elements desactivats.| |lastChangeSince|timestamp|Retorna només els triggers que han canviat d'estat després del temps d'espera.| |lastChangeTill|timestamp|Retorna només els triggers que han canviat d'estat abans de l'hora especificada.| |només\_true|flag|Retorna només els triggers que han tingut un problema recentment.| |min\_severity|enteger|Retorna només triggers amb una gravetat superior o igual a la gravetat donada.| |evaltype|integer|Regles per a la cerca d'etiquetes.[{"tag": "<etiqueta>", "valor": "< valor>", "operador". ": "<operador>"}, ...].functions.functionid- *(cadena)* ID de la funció;itemid- *(cadena)* ID de l'element utilitzat a la funció;triggerid- *(cadena)* ID del trigger que utilitza la funció;function- *(cadena)* nom de la funció;parameter- *(cadena)* paràmetre passat a la funció. El paràmetre de consulta es substitueix pel símbol$a la cadena retornada.| |selectDependencies|query|Retorna els triggers dels quals depèn el trigger a la propietatdependencies.| |selectDiscoveryRule|query|Retorna la [regla de descobriment de baix nivell](/manual/api/reference/discoveryrule/object#discovery_rule) que ha creat el trigger.| |selectLastEvent|query|Retorna el darrer esdeveniment de trigger significatiu a la propietat [lastEvent](/manual/api/reference/event/objecte).| |selectTags|query|Retorna les etiquetes de trigger a la propietat [etiquetes](/manual/api/reference/trigger/object#Trigger_tag).| |selectTriggerDiscovery|query|Retorna l'objecte de descoberta del trigger a la propietattriggerDiscovery. Els objectes de descobriment del trigger emllaçen el trigger a un prototip de trigger a partir del qual s'ha creat.parent_triggerid-(cadena)ID del prototip de trigger des del qual s'ha creat el trigger.| |filter|object|Només retorna resultats que coincideixen exactament amb el filtre donat.host- nom tècnic de l'equip al qual pertany el trigger;hostid- ID de l'equip al qual pertany el trigger.| |limitSelects|integer|Limita el nombre de registres retornats per les subconsultes.selectHosts: els resultats s'ordenaran perhost.| |sortfield|string/array|[Ordena](/fr/manual/api/reference_commentary#Common_parameters_of_the_get_method) el resultat per les propietats donades.triggerid,description,status,priority,lastchangeihostname`. |
| countOutput | boolean | Aquests paràmetres es descriuen als comentaris de referència. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
recuperar informació per ID de trigger
Recuperar tota la informació i les funcions que empra el trigger "14062".
Petició:
{ "jsonrpc": "2.0", "method": "trigger.get", "params": { "triggerids": "14062", "output": "extend", "selectFunctions": "extend" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Resposta:
{ "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", "parameter": "$", "function": "last" } ] } ], "id": 1 }Recuperar els triggers amb estat problemàtic
Recuperar l'ID, nom i gravetat de tots els triggers en estat problemàtic, i ordenar-los per gravetat en ordre decreixent.
Petició:
{ "jsonrpc": "2.0", "method": "trigger.get", "params": { "output": [ "triggerid", "description", "priority" ], "filter": { "value": 1 }, "sortfield": "priority", "sortorder": "DESC" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Resposta:
{ "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 }Recuperar un trigger específic amb etiquetes
Recuperar un trigger específic amb etiquetes.
Petició:
{ "jsonrpc": "2.0", "method": "trigger.get", "params": { "output": [ "triggerid", "description" ], "selectTags": "extend", "triggerids": [ "17578" ] }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Resposta:
{ "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 }Veieu també
Font
CTrigger::get() in ui/include/classes/api/services/CTrigger.php.