Table of Contents
trigger.get
Descripción
integer/array trigger.get(object parameters)
El método permite recuperar disparadores según los parámetros dados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para más información.
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 | Devolver solo disparadores con los IDs indicados. |
| groupids | ID/array | Devolver solo disparadores que pertenezcan a equipos o plantillas de los grupos de equipos o grupos de plantillas indicados. |
| templateids | ID/array | Devolver solo disparadores que pertenezcan a las plantillas indicadas. |
| hostids | ID/array | Devolver solo disparadores que pertenezcan a los equipos indicados. |
| itemids | ID/array | Devolver solo disparadores que contengan las métricas indicadas. |
| functions | string/array | Devolver solo disparadores que utilicen las funciones indicadas. Consulte la página de funciones soportadas para ver una lista de funciones soportadas. |
| group | string | Devolver solo disparadores que pertenezcan a equipos o plantillas del grupo de equipos o grupo de plantillas con el nombre indicado. |
| host | string | Devolver solo disparadores que pertenezcan al equipo con el nombre técnico indicado. |
| inherited | boolean | Si se establece en true, devolver solo disparadores heredados de una plantilla. |
| templated | boolean | Si se establece en true, devolver solo disparadores que pertenezcan a plantillas. |
| dependent | boolean | Si se establece en true, devolver solo disparadores que tengan dependencias. Si se establece en false, devolver solo disparadores que no tengan dependencias. |
| monitored | flag | Devolver solo disparadores habilitados que pertenezcan a equipos monitorizados y contengan solo métricas habilitadas. |
| active | flag | Devolver solo disparadores habilitados que pertenezcan a equipos monitorizados. |
| maintenance | boolean | Si se establece en true, devolver solo disparadores habilitados que pertenezcan a equipos en mantenimiento. |
| withUnacknowledgedEvents | flag | Devolver solo disparadores que tengan eventos no reconocidos. |
| withAcknowledgedEvents | flag | Devolver solo disparadores con todos los eventos reconocidos. |
| withLastEventUnacknowledged | flag | Devolver solo disparadores con el último evento no reconocido. |
| skipDependent | flag | Omitir disparadores en estado de problema que dependan de otros disparadores. Tenga en cuenta que los otros disparadores se ignoran si están deshabilitados, tienen métricas deshabilitadas o equipos de métricas deshabilitados. |
| lastChangeSince | timestamp | Devolver solo disparadores que hayan cambiado su estado después del tiempo indicado. |
| lastChangeTill | timestamp | Devolver solo disparadores que hayan cambiado su estado antes del tiempo indicado. |
| only_true | flag | Devolver solo disparadores que hayan estado recientemente en estado de problema. |
| min_severity | integer | Devolver solo disparadores con una gravedad mayor o igual a la gravedad indicada. |
| evaltype | integer | Reglas para la búsqueda de etiquetas. Valores posibles: 0 - (por defecto) Y/O; 2 - O. |
| tags | array | Devolver solo disparadores con las etiquetas indicadas. Coincidencia exacta por etiqueta y búsqueda sensible o no sensible a mayúsculas/minúsculas por valor de etiqueta dependiendo del valor del operador. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Un array vacío devuelve todos los disparadores. Tipos de operador posibles: 0 - (por defecto) Like; 1 - Igual; 2 - No like; 3 - No igual; 4 - Existe; 5 - No existe. |
| expandComment | flag | Expandir macros en la descripción del disparador. |
| expandDescription | flag | Expandir macros en el nombre del disparador. |
| expandExpression | flag | Expandir funciones y macros en la expresión del disparador. |
| selectHostGroups | query | Devolver los grupos de equipos a los que pertenece el disparador en la propiedad hostgroups. |
| selectHosts | query | Devolver los equipos a los que pertenece el disparador en la propiedad hosts. |
| selectItems | query | Devolver las métricas contenidas por el disparador en la propiedad items. |
| selectFunctions | query | Devolver las funciones utilizadas en el disparador en la propiedad functions.Los objetos de función representan las funciones utilizadas en la expresión del disparador y tienen las siguientes propiedades: functionid - (ID) ID de la función;itemid - (ID) ID de la métrica utilizada 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 reemplaza por el símbolo $ en la cadena devuelta. |
| selectDependencies | query | Devolver los disparadores de los que depende el disparador en la propiedad dependencies. |
| selectDiscoveryData | query | Devolver una propiedad discoveryData con los datos del objeto de descubrimiento de disparadores. El objeto de descubrimiento de disparadores vincula un disparador descubierto a un prototipo de disparador del que fue descubierto.Tiene las siguientes propiedades: parent_triggerid - (ID) ID del prototipo de disparador del que se ha creado el disparador;status - (int) estado de descubrimiento del disparador:0 - (por defecto) el disparador está descubierto, 1 - el disparador ya no está descubierto; ts_delete - (timestamp) hora en la que se eliminará un disparador que ya no está descubierto;ts_disable - (timestamp) hora en la que se deshabilitará un disparador que ya no está descubierto;disable_source - (int) indicador de si el disparador fue deshabilitado por una regla LLD o manualmente:0 - (por defecto) deshabilitado automáticamente, 1 - deshabilitado por una regla LLD. |
| selectDiscoveryRule | query | Devolver la regla de descubrimiento de bajo nivel que creó el disparador en la propiedad discoveryRule. |
| selectDiscoveryRulePrototype | query | Devolver una propiedad discoveryRulePrototype con el prototipo de regla LLD principal que creó el disparador. |
| selectLastEvent | query | Devolver el último evento significativo del disparador en la propiedad lastEvent. |
| selectTags | query | Devolver las etiquetas del disparador en la propiedad tags. |
| selectTemplateGroups | query | Devolver los grupos de plantillas a los que pertenece el disparador en la propiedad templategroups. |
| selectTriggerDiscovery | query | Devolver el objeto de descubrimiento de disparadores en la propiedad triggerDiscovery. Los objetos de descubrimiento de disparadores vinculan el disparador a un prototipo de disparador del que fue creado.Esta consulta está obsoleta, por favor utilice selectDiscoveryData en su lugar. |
| filter | object | Devolver solo aquellos resultados que coincidan exactamente con el filtro indicado. Acepta un objeto, donde las claves son nombres de propiedades y los valores son un único valor o un array de valores con los que comparar. No admite propiedades del tipo de datos text data type.Admite propiedades adicionales: host - nombre técnico del equipo al que pertenece el disparador;hostid - ID del equipo al que pertenece el disparador. |
| limitSelects | integer | Limita el número de registros devueltos por subconsultas. Se aplica a las siguientes subconsultas: selectHosts - los resultados se ordenarán por host. |
| sortfield | string/array | Ordenar el resultado por las propiedades indicadas. Valores posibles: triggerid, description, status, priority, lastchange, hostname. |
| countOutput | boolean | Estos parámetros se describen en el comentario de referencia. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valores de retorno
(integer/array) Devuelve:
- un array de objetos;
- el número 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".
{
"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 equipo 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",
"triggerid": "14062",
"parameter": "$",
"function": "last"
}
]
}
],
"id": 1
}Recuperar disparadores en estado de problema
Recuperar el ID, nombre y gravedad de todos los disparadores en estado de problema y ordenarlos por gravedad en orden descendente.
{
"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 disparador específico con etiquetas
Recuperar un disparador específico con etiquetas.
{
"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
}Véase también
Fuente
CTrigger::get() en ui/include/classes/api/services/CTrigger.php.