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
(object) 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 eventos con los IDs indicados. |
| groupids | ID/array | Devolver solo eventos creados por objetos que pertenecen a los grupos de equipos indicados. |
| hostids | ID/array | Devolver solo eventos creados por objetos que pertenecen a los equipos indicados. |
| objectids | ID/array | Devolver solo eventos creados por los objetos indicados. |
| source | integer | Devolver solo eventos con el tipo indicado. Consulte la página del objeto evento para ver una lista de los tipos de eventos soportados. Por defecto: 0 - eventos de disparador. |
| object | integer | Devolver solo eventos creados por objetos del tipo indicado. Consulte la página del objeto evento para ver una lista de los tipos de objetos soportados. Por defecto: 0 - disparador. |
| acknowledged | boolean | Si se establece en true, devuelve solo eventos reconocidos. |
| action | integer | Devolver solo eventos para los cuales se han realizado las acciones de actualización de eventos indicadas. Para múltiples acciones, utilice la suma de cualquier valor de bit aceptable como máscara de bits (por ejemplo, 34 para reconocer y suprimir evento). |
| action_userids | ID/array | Devolver solo eventos con los IDs de usuarios que realizaron las acciones de actualización de eventos indicadas. |
| suppressed | boolean | true - devolver solo eventos suprimidos;false - devolver eventos en estado normal. |
| symptom | boolean | true - devolver solo eventos de síntoma;false - devolver solo eventos de causa. |
| severities | integer/array | Devolver solo eventos con las severidades de evento indicadas. Aplica solo si el objeto es disparador. |
| trigger_severities | integer/array | Devolver solo eventos con las severidades de disparador indicadas. Aplica solo si el objeto es disparador. |
| evaltype | integer | Reglas para la búsqueda de etiquetas. Valores posibles: 0 - (por defecto) Y/O; 2 - O. |
| tags | array | Devolver solo eventos con las etiquetas indicadas. Coincidencia exacta por etiqueta y búsqueda insensible a mayúsculas/minúsculas por valor y operador. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].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 | string | Devolver solo eventos con IDs mayores o iguales al ID indicado. |
| eventid_till | string | Devolver solo eventos con IDs menores o iguales al ID indicado. |
| time_from | timestamp | Devolver solo eventos que hayan sido creados después o en el momento indicado. |
| time_till | timestamp | Devolver solo eventos que hayan sido creados antes o en el momento indicado. |
| problem_time_from | timestamp | Devuelve solo eventos que estuvieron en estado de problema comenzando con problem_time_from. Aplica solo si la fuente es evento de disparador y el objeto es disparador. Obligatorio si se especifica problem_time_till. |
| problem_time_till | timestamp | Devuelve solo eventos que estuvieron en estado de problema hasta problem_time_till. Aplica solo si la fuente es evento de disparador y el objeto es disparador. Obligatorio si se especifica problem_time_from. |
| value | integer/array | Devolver solo eventos con los valores indicados. |
| selectAcknowledges | query | Devuelve una propiedad acknowledges con las actualizaciones de eventos. Las actualizaciones de eventos 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 - (string) texto del mensaje;action - (integer) acción de actualización realizada, ver event.acknowledge;old_severity - (integer) severidad del evento antes de esta acción de actualización;new_severity - (integer) 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 - (string) nombre de usuario del usuario que actualizó el evento;name - (string) nombre del usuario que actualizó el evento;surname - (string) apellido del usuario que actualizó el evento.Soporta count. |
| selectAlerts | query | Devuelve una propiedad alerts con las alertas generadas por el evento. Las alertas se ordenan en orden cronológico inverso. |
| selectHosts | query | Devuelve una propiedad hosts con los equipos que contienen el objeto que creó el evento. Solo es compatible con eventos generados por disparadores, métricas o reglas LLD. |
| selectRelatedObject | query | Devuelve una propiedad relatedObject con el objeto que creó el evento. El tipo de objeto devuelto depende del tipo de evento. |
| selectSuppressionData | query | 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 - (integer) hora hasta la que el evento está suprimido. |
| selectTags | query | Devuelve una propiedad tags con las etiquetas del evento. |
| filter | object | 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 | string/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 | string/array | Agrupa los resultados por las propiedades indicadas. Las propiedades especificadas se devolverán en los resultados. Valores posibles: objectid. |
| 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, 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.