Table of Contents
event.get
Descripción
integer/array event.get(object parameters)
El método permite recuperar eventos según los parámetros dados.
Este método puede devolver eventos de una entidad eliminada si estos eventos no han sido eliminados por el housekeeper todavía.
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
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| eventids | ID/array | Devolver solo los eventos con los IDs indicados. |
| groupids | ID/array | Devolver solo los eventos creados por objetos que pertenezcan a los grupos de hosts indicados. |
| hostids | ID/array | Devolver solo los eventos creados por objetos que pertenezcan a los hosts indicados. |
| objectids | ID/array | Devolver solo los eventos creados por los objetos indicados. |
| source | entero | Devolver solo los eventos con el tipo indicado. Consulte la página del objeto evento para ver una lista de los tipos de eventos admitidos. Por defecto: 0 - eventos de disparador. |
| object | entero | Devolver solo los eventos creados por objetos del tipo indicado. Consulte la página del objeto evento para ver una lista de los tipos de objetos admitidos. Por defecto: 0 - disparador. |
| acknowledged | booleano | Si se establece en true, devolver solo los eventos reconocidos. |
| action | entero | Devolver solo los eventos para los que se hayan realizado las acciones de actualización de evento indicadas. Para múltiples acciones, utilice una suma de cualquier valor de mapa de bits aceptable como máscara de bits (por ejemplo, 34 para reconocer y suprimir evento). |
| action_userids | ID/array | Devolver solo los eventos con los IDs de usuarios que realizaron las acciones de actualización de evento indicados. |
| suppressed | booleano | true - devolver solo los eventos suprimidos;false - devolver eventos en estado normal. |
| symptom | booleano | true - devolver solo eventos de síntoma;false - devolver solo eventos de causa. |
| severities | entero/array | Devolver solo los eventos con las severidades de evento indicadas. Solo se aplica si el objeto es disparador. |
| trigger_severities | entero/array | Devolver solo los eventos con las severidades de disparador indicadas. Solo se aplica si el objeto es disparador. |
| evaltype | entero | Reglas para la búsqueda de etiquetas. Valores posibles: 0 - (por defecto) Y/O; 2 - O. |
| tags | array | Devolver solo los eventos con las etiquetas indicadas. Coincidencia exacta por etiqueta y búsqueda insensible a mayúsculas/minúsculas por valor y operador. Formato: [{"tag": "<etiqueta>", "value": "<valor>", "operator": "<operador>"}, ...].Un array vacío devuelve todos los eventos. Tipos de operador posibles: 0 - (por defecto) Like; 1 - Igual; 2 - No like; 3 - No igual 4 - Existe; 5 - No existe. |
| eventid_from | cadena | Devolver solo los eventos con IDs mayores o iguales al ID indicado. |
| eventid_till | cadena | Devolver solo los eventos con IDs menores o iguales al ID indicado. |
| time_from | timestamp | Devolver solo los eventos que se hayan creado después o en el momento indicado. |
| time_till | timestamp | Devolver solo los eventos que se hayan creado antes o en el momento indicado. |
| problem_time_from | timestamp | Devuelve solo los eventos que estuvieron en estado de problema desde problem_time_from independientemente de su estado actual. Solo se aplica cuando la fuente es un evento de disparador y el objeto es un disparador. Este parámetro es obligatorio si se especifica problem_time_till. |
| problem_time_till | timestamp | Devuelve solo los eventos que estuvieron en estado de problema hasta problem_time_till independientemente de su estado actual. Solo se aplica cuando la fuente es un evento de disparador y el objeto es un disparador. Este parámetro es obligatorio si se especifica problem_time_from. |
| value | entero/array | Devolver solo los eventos con los valores indicados. |
| selectAcknowledges | consulta | Devuelve una propiedad acknowledges con las actualizaciones del evento. Las actualizaciones del evento se ordenan en orden cronológico inverso.El objeto de actualización de evento tiene las siguientes propiedades: acknowledgeid - (ID) ID del reconocimiento;userid - (ID) ID del usuario que actualizó el evento;clock - (timestamp) hora en que se actualizó el evento;message - (cadena) texto del mensaje;action - (entero) acción de actualización realizada, ver event.acknowledge;old_severity - (entero) severidad del evento antes de esta acción de actualización;new_severity - (entero) severidad del evento después de esta acción de actualización;suppress_until - (timestamp) hora hasta la que el evento estará suprimido;taskid - (ID) ID de la tarea si el evento actual está experimentando un cambio de rango;username - (cadena) nombre de usuario del usuario que actualizó el evento;name - (cadena) nombre del usuario que actualizó el evento;surname - (cadena) apellido del usuario que actualizó el evento.Admite count. |
| selectAlerts | consulta | Devuelve una propiedad alerts con las alertas generadas por el evento. Las alertas se ordenan en orden cronológico inverso. |
| selectHosts | consulta | Devuelve una propiedad hosts con los hosts que contienen el objeto que creó el evento. Solo es compatible con eventos generados por disparadores, elementos o reglas LLD. |
| selectRelatedObject | consulta | Devuelve una propiedad relatedObject con el objeto que creó el evento. El tipo de objeto devuelto depende del tipo de evento. |
| selectSuppressionData | consulta | Devuelve una propiedad suppression_data con la lista de mantenimientos activos y supresiones manuales:maintenanceid - (ID) ID del mantenimiento;userid - (ID) ID del usuario que suprimió el evento;suppress_until - (entero) hora hasta la que el evento está suprimido. |
| selectTags | consulta | Devuelve una propiedad tags con las etiquetas del evento. |
| filter | objeto | Devuelve 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 de tipo de dato text data type. |
| sortfield | cadena/array | Ordena el resultado por las propiedades indicadas. Valores posibles: eventid, objectid, clock.Valores posibles cuando se usa junto con groupBy: objectid.Valores posibles cuando se usa junto con countOutput y groupBy: objectid, rowscount. |
| groupBy | cadena/array | Agrupa los resultados por las propiedades indicadas. Las propiedades especificadas se devolverán en los resultados. Valores posibles: objectid. |
| countOutput | booleano | Estos parámetros se describen en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/array | |
| startSearch | booleano |
Valores de retorno
(integer/array) Devuelve:
- un array de objetos;
- el número de objetos recuperados, si se ha utilizado el parámetro
countOutput, pero no se ha utilizado el parámetrogroupBy; - un array de objetos con resultados de agregación, si se ha utilizado el parámetro
groupBy.
Ejemplos
Recuperar eventos de disparadores
Recuperar los eventos más recientes del disparador "22395".
{
"jsonrpc": "2.0",
"method": "event.get",
"params": {
"output": "extend",
"selectAcknowledges": "extend",
"selectSuppressionData": "extend",
"selectTags": "extend",
"objectids": "22395",
"sortfield": ["clock", "eventid"],
"sortorder": "DESC"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"eventid": "20",
"source": "0",
"object": "0",
"objectid": "22395",
"clock": "1728658089",
"value": "0",
"acknowledged": "0",
"ns": "461809482",
"name": "El promedio de carga es demasiado alto (carga por CPU superior a 1.5 durante 5m)",
"severity": "0",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"acknowledges": [],
"opdata": "Promedios de carga(1m 5m 15m): (1.6328 3.0522 2.2515), # de CPUs: 2",
"suppression_data": [],
"suppressed": "0",
"tags": [
{
"tag": "scope",
"value": "capacity"
},
{
"tag": "scope",
"value": "performance"
},
{
"tag": "component",
"value": "cpu"
},
{
"tag": "class",
"value": "os"
},
{
"tag": "target",
"value": "linux"
}
],
"urls": []
},
{
"eventid": "4",
"source": "0",
"object": "0",
"objectid": "22395",
"clock": "1728657737",
"value": "1",
"acknowledged": "1",
"ns": "460759366",
"name": "El promedio de carga es demasiado alto (carga por CPU superior a 1.5 durante 5m)",
"severity": "3",
"r_eventid": "20",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"acknowledges": [
{
"acknowledgeid": "1",
"userid": "1",
"clock": "1728657938",
"message": "Entorno de pruebas. Por favor, ignore esta alerta.",
"action": "38",
"old_severity": "0",
"new_severity": "0",
"suppress_until": "1728744338",
"taskid": "0",
"username": "Admin",
"name": "Zabbix",
"surname": "Administrator"
}
],
"opdata": "Promedios de carga(1m 5m 15m): (1.6328 3.0522 2.2515), # de CPUs: 2",
"suppression_data": [
{
"maintenanceid": "0",
"suppress_until": "1728744338",
"userid": "1"
}
],
"suppressed": "1",
"tags": [
{
"tag": "scope",
"value": "capacity"
},
{
"tag": "scope",
"value": "performance"
},
{
"tag": "component",
"value": "cpu"
},
{
"tag": "class",
"value": "os"
},
{
"tag": "target",
"value": "linux"
}
],
"urls": []
}
],
"id": 1
}Recuperar eventos por período de tiempo
Recuperar todos los eventos que se han creado entre el 17 y 18 de octubre de 2012, en orden cronológico inverso.
{
"jsonrpc": "2.0",
"method": "event.get",
"params": {
"output": "extend",
"time_from": "1350432000",
"time_till": "1350518400",
"sortfield": ["clock", "eventid"],
"sortorder": "DESC"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"eventid": "20617",
"source": "0",
"object": "0",
"objectid": "14282",
"clock": "1350477816",
"value": "1",
"acknowledged": "0",
"ns": "0",
"name": "Menos del 25% libre en la caché de historial",
"severity": "3",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"opdata": "",
"suppressed": "0",
"urls": []
},
{
"eventid": "20616",
"source": "0",
"object": "0",
"objectid": "14281",
"clock": "1350477814",
"value": "0",
"acknowledged": "0",
"ns": "0",
"name": "Procesos Zabbix trapper más del 75% ocupados",
"severity": "0",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"opdata": "",
"suppressed": "0",
"urls": []
},
{
"eventid": "20615",
"source": "0",
"object": "0",
"objectid": "14281",
"clock": "1350477541",
"value": "1",
"acknowledged": "0",
"ns": "0",
"name": "Procesos Zabbix trapper más del 75% ocupados",
"severity": "3",
"r_eventid": "20616",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"opdata": "",
"suppressed": "0",
"urls": []
}
],
"id": 1
}Recuperar eventos reconocidos por un usuario especificado
Recuperar eventos reconocidos por el usuario con ID=10
{
"jsonrpc": "2.0",
"method": "event.get",
"params": {
"output": "extend",
"action": 2,
"action_userids": [10],
"selectAcknowledges": ["userid", "action"],
"sortfield": ["eventid"],
"sortorder": "DESC"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"eventid": "503",
"source": "0",
"object": "0",
"objectid": "23162",
"clock": "1747212236",
"value": "1",
"acknowledged": "1",
"ns": "413470863",
"name": "Number of installed packages has been changed",
"severity": "2",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"acknowledges": [
{
"userid": "10",
"action": "2"
}
],
"opdata": "",
"suppressed": "0",
"urls": []
}
],
"id": 1
}Recuperar los principales disparadores con el recuento de eventos problemáticos
Recupera los 5 principales disparadores que tienen las severidades "Advertencia", "Media", "Alta" o "Desastre", junto con el número de eventos problemáticos dentro de un período de tiempo especificado.
{
"jsonrpc": "2.0",
"method": "event.get",
"params": {
"countOutput": true,
"groupBy": "objectid",
"source": 0,
"object": 0,
"value": 1,
"time_from": 1672531200,
"time_till": 1677628800,
"trigger_severities": [2, 3, 4, 5],
"sortfield": ["rowscount"],
"sortorder": "DESC",
"limit": 5
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"objectid": "232124",
"rowscount": "27"
},
{
"objectid": "29055",
"rowscount": "23"
},
{
"objectid": "253731",
"rowscount": "18"
},
{
"objectid": "254062",
"rowscount": "11"
},
{
"objectid": "23216",
"rowscount": "7"
}
],
"id": 1
}Véase también
Fuente
CEvent::get() en ui/include/classes/api/services/CEvent.php.