trigger.get

Descripción

integer/array trigger.get(object parameters)

El método permite recuperar iniciadores según los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Para más información, consulte Roles de usuario.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
triggerids ID/array Devuelve solo los triggers con los ID especificados.
groupids ID/array Devuelve solo los triggers que pertenecen a hosts o templates de los grupos de hosts o grupos de templates especificados.
templateids ID/array Devuelve solo los triggers que pertenecen a los templates especificados.
hostids ID/array Devuelve solo los triggers que pertenecen a los hosts especificados.
itemids ID/array Devuelve solo los triggers que contienen los items especificados.
functions string/array Devuelve solo los triggers que usan las funciones especificadas.

Consulte la página de funciones compatibles para ver una lista de las funciones compatibles.
group string Devuelve solo los triggers que pertenecen a hosts o templates del grupo de hosts o grupo de templates con el nombre especificado.
host string Devuelve solo los triggers que pertenecen al host con el nombre técnico especificado.
inherited boolean Si se establece en true, devuelve solo los triggers heredados de un template.
templated boolean Si se establece en true, devuelve solo los triggers que pertenecen a templates.
dependent boolean Si se establece en true, devuelve solo los triggers que tienen dependencias. Si se establece en false, devuelve solo los triggers que no tienen dependencias.
monitored flag Devuelve solo los triggers habilitados que pertenecen a hosts monitorizados y contienen solo items habilitados.
active flag Devuelve solo los triggers habilitados que pertenecen a hosts monitorizados.
maintenance boolean Si se establece en true, devuelve solo los triggers habilitados que pertenecen a hosts en mantenimiento.
withUnacknowledgedEvents flag Devuelve solo los triggers que tienen eventos no reconocidos.
withAcknowledgedEvents flag Devuelve solo los triggers con todos los eventos reconocidos.
withLastEventUnacknowledged flag Devuelve solo los triggers cuyo último evento no está reconocido.
skipDependent flag Omite los triggers en estado de problema que dependen de otros triggers. Tenga en cuenta que los otros triggers se ignoran si están deshabilitados, tienen items deshabilitados o hosts de item deshabilitados.
lastChangeSince timestamp Devuelve solo los triggers que han cambiado de estado después del momento especificado.
lastChangeTill timestamp Devuelve solo los triggers que han cambiado de estado antes del momento especificado.
only_true flag Devuelve solo los triggers que recientemente han estado en estado de problema.
min_severity integer Devuelve solo los triggers con una severidad mayor o igual que la severidad especificada.
evaltype integer Método de evaluación de etiquetas.

Valores posibles:
0 - (predeterminado) And/Or;
2 - Or.
tags array Devuelve solo los triggers con las etiquetas especificadas.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vacío devuelve todos los triggers.

Valores posibles de operator:
0 - (predeterminado) Contiene;
1 - Igual a;
2 - No contiene;
3 - No es igual a;
4 - Existe;
5 - No existe.
expandComment flag Expande las macros en la descripción del trigger.
expandDescription flag Expande las macros en el nombre del trigger.
expandExpression flag Expande las funciones y macros en la expresión del trigger.
selectHostGroups query Devuelve los grupos de hosts a los que pertenece el trigger en la propiedad hostgroups.
selectHosts query Devuelve los hosts a los que pertenece el trigger en la propiedad hosts.
selectItems query Devuelve los items contenidos por el trigger en la propiedad items.
selectFunctions query Devuelve las funciones utilizadas en el trigger en la propiedad functions.

Los objetos de función representan las funciones utilizadas en la expresión del trigger y tienen las siguientes propiedades:
functionid - (ID) ID de la función;
itemid - (ID) ID del item utilizado en la función;
function - (string) nombre de la función;
parameter - (string) parámetro pasado a la función. El parámetro de consulta se sustituye por el símbolo $ en la cadena devuelta.
selectDependencies query Devuelve los triggers de los que depende el trigger en la propiedad dependencies.
selectDiscoveryRule query Devuelve la regla de descubrimiento de bajo nivel que creó el trigger en la propiedad discoveryRule.
selectLastEvent query Devuelve el último evento significativo del trigger en la propiedad lastEvent.
selectTags query Devuelve las etiquetas del trigger en la propiedad tags.
selectTemplateGroups query Devuelve los grupos de templates a los que pertenece el trigger en la propiedad templategroups.
selectTriggerDiscovery query Devuelve el objeto de descubrimiento del trigger en la propiedad triggerDiscovery. Los objetos de descubrimiento del trigger vinculan el trigger con un prototipo de trigger a partir del cual fue creado.

Tiene las siguientes propiedades:
parent_triggerid - (ID) ID del prototipo de trigger a partir del cual se ha creado el trigger;
status - (int) estado de descubrimiento del trigger:
0 - (predeterminado) el trigger está descubierto,
1 - el trigger ya no está descubierto;
ts_delete - (timestamp) momento en que se eliminará un trigger que ya no se descubra;
ts_disable - (timestamp) momento en que se deshabilitará un trigger que ya no se descubra;
disable_source - (int) indicador de si el trigger fue deshabilitado por una regla LLD o manualmente:
0 - (predeterminado) deshabilitado automáticamente,
1 - deshabilitado por una regla LLD.
filter object Devuelve solo aquellos resultados que coinciden exactamente con el filtro especificado.

Acepta un objeto, donde las claves son nombres de propiedades y los valores son un valor único o un array de valores con los que comparar.

No admite propiedades del tipo de datos text.

Admite propiedades adicionales:
host - nombre técnico del host al que pertenece el trigger;
hostid - ID del host al que pertenece el trigger.
limitSelects integer Limita el número de registros devueltos por las subselecciones.

Se aplica a las siguientes subselecciones:
selectHosts - los resultados se ordenarán por host.
sortfield string/array Ordena el resultado por las propiedades especificadas.

Valores posibles: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Estos parámetros se describen en los comentarios de referencia.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(obsoleto)		 query Este parámetro está obsoleto; utilice selectHostGroups o selectTemplateGroups en su lugar.
Devuelve los grupos de hosts y grupos de templates a los que pertenece el trigger en la propiedad groups.

Valores de retorno

(entero/matriz) Devuelve:

  • una variedad de objetos;
  • el recuento de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar datos por ID de disparador

Recuperar todos los datos y las funciones utilizadas en el disparador "14062".

Solicitud:

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

Respuesta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "14062",
            "expression": "{13513}<10m",
            "description": "{HOST.NAME} ha sido reiniciado (tiempo de actividad < 10m)",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "El tiempo de actividad del host es menor a 10 minutos",
            "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",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Recuperar iniciadores en estado de problema

Recupere el ID, el nombre y la gravedad de todos los iniciadores en estado de problema y ordénelos por gravedad en orden descendente.

Solicitud:

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

Respuesta:

{
"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 iniciador específico con etiquetas

Recupera un iniciador específico con etiquetas.

Solicitud:

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

Respuesta:

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

Ver también

Fuente

CTrigger::get() en ui/include/classes/api/services/CTrigger.php.