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 ID/array Retorna només triggers amb els identificadors donats.
groupids ID/array Retorna només triggers que pertanyen als equips dels grups d'equips donats.
templateids ID/array Retorna només triggers que pertanyen a les plantilles donades.
hostids ID/array Retorna només triggers que pertanyen als equips donats.
itemids ID/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 a true, 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 Etiqueta mètode d'avaluació.

Valors possibles:
0 - (per defecte) I/O;
2 - O.
tags array Retorna només els activadors amb les etiquetes donades.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Una matriu buida retorna tots els triggers.

Valors possibles de l'operator:
0 - (per defecte) Conté;
1 - Igual a;
2 - No conté;
3 - No és igual a;
4 - Existeix;
5 - No existeix.

|expandComment|flag|Amplieu les macros a la descripció del trigger.| |expandDescription|flag|Amplieu les macros al nom del trigger.| |expandExpression|flag|Amplieu macros i funcions a l'expressió del trigger.| |selectHostGroups|query|Retorna els grups d'equips als quals pertany el trigger a la propietat hostgrups.| |selectHosts|query|Retorna els equips als quals pertany el trigger a la propietat equips.| |selectItems|query|Retorna els elements continguts al trigger a la propietat elements.| |selectFunctions|query|Retorna les funcions emprades al trigger a la propietat functions.

Els objectes de funció representen les funcions emprades a l'expressió trigger i tenen les propietats següents:
functionid - (ID) ID de la funció;
itemid - (ID) ID de l'element emprat a la funció;
function - (string) nom de la funció;
parameter - (string) 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 propietat dependencies.| |selectDiscoveryData|query|Retorna una propietat discoveryData amb les dades de l'objecte de descoberta del trigger. L'objecte de descoberta del trigger enllaça un trigger trobat a un prototip de trigger a partir del qual s'ha trobat.

Té les propietats següents:
parent_triggerid - (ID) ID del prototip de trigger a partir del qual s'ha creat el trigger;
status - (int) estat de descoberta del trigger:
0 - (per defecte) s'ha trobat el trigger,
1 - el trigger ja no es busca;
ts_delete - (timestamp) hora en què s'esborrarà un trigger que ja no es troba;
ts_disable - (timestamp) hora en què es desactivarà un trigger que ja no es troba;
disable_source - (int) indicador de si el trigger es va desactivar per una regla LLD o manualment:
0 - (per defecte) desactivat automàticament,
1 - desactivat per una regla LLD.| |selectDiscoveryRule|query|Retorna la regla de descoberta de baix nivell que ha creat el trigger.| |selectDiscoveryRulePrototype|query|Retorna una propietat discoveryRulePrototype amb el prototip de regla LLD principal que va crear el trigger.| |selectLastEvent|query|Retorna el darrer esdeveniment de trigger significatiu a la propietat lastEvent.| |selectTags|query|Retorna les etiquetes de trigger a la propietat etiquetes.| |selectTemplateGroups|query|Retorna els grups de plantilles als quals pertany el trigger a la propietat templategrups.| |selectTriggerDiscovery|query|Retorna l'objecte de descoberta del trigger a la propietat triggerDiscovery. Els objectes de descoberta del trigger emllaçen el trigger a un prototip de trigger a partir del qual s'ha creat.

Té les propietats següents:
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.

Accepta una matriu on les claus són noms de propietat i els valors són un valor únic o una matriu de valors per comparar.< br>\\Admet filtres addicionals:
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.

S'aplica a les subseleccions següents:
selectHosts: els resultats s'ordenaran per host.| |sortfield|string/array|Ordena el resultat per les propietats donades.

Valors possibles: triggerid, description, status, priority, lastchange i hostname.| |countOutput|boolean|Aquests paràmetres es descriuen als comentaris de referència.| |editable|boolean|^| |excludeSearch|boolean|^| |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

Recupera 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"
    },
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "14062",
            "expression": "{13513}<10m",
            "description": "L'equip {HOST.NAME} s'ha hagut de reiniciar (temps d'activitat < 10m)",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "El temps d'activitat de l'equip és inferior a 10 minuts",
            "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
}

Recuperar els triggers amb estat problemàtic

Recupera 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"
    },
    "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"
        ]
    },
    "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.