Documentation
Table of Contents
event.get
Descripción
integer/array event.get(object parameters)
El método permite recuperar eventos de acuerdo con los parámetros dados.
Este método puede devolver eventos de una entidad eliminada. si estos eventos no han sido eliminados todavía por las tareas de limpieza.
Este método está disponible para usuarios de cualquier tipo. Los `ermisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver 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 | cadena/matriz | Devuelve solo eventos con los ID proporcionados. |
| groupids | cadena/matriz | Devuelve solo eventos creados por objetos que pertenecen a los grupos de equipos dados. |
| hostids | cadena/matriz | Devuelve solo eventos creados por objetos que pertenecen a los equipos dados. |
| objectids | cadena/matriz | Devuelve solo eventos creados por los objetos dados. |
| source | entero | Devuelve solo eventos con el tipo dado. Consulte la página de objeto de evento para obtener una lista de los tipos de eventos admitidos. Valor predeterminado: 0 - desencadenar eventos. |
| object | entero | Devuelve solo eventos creados por objetos del tipo dado. Consulte la página de objeto de evento para obtener una lista de los tipos de objetos admitidos. Predeterminado : 0 - iniciador. |
| acknowledged | booleano | Si se establece en "verdadero", devuelve solo eventos reconocidos. |
| suppressed | booleano | true - devuelve solo eventos suprimidos;false - devuelve eventos en el estado normal. |
| symptom | booleano | true - devuelve solo eventos de síntomas;false - devuelve solo eventos de causa. |
| severities | entero/matriz | Devuelve solo eventos con gravedades de evento determinadas. Se aplica sólo si el objeto es el desencadenante. |
| evaltype | entero | Reglas para la búsqueda de etiquetas. Valores posibles: 0 - (predeterminado) Y/O; 2 - O. |
| tags | matriz de objetos | Devuelve solo eventos con etiquetas dadas. Coincidencia exacta por etiqueta y búsqueda que no distingue entre mayúsculas y minúsculas por valor y operador. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator> "}, ...].Una matriz vacía devuelve todos los eventos. Tipos de operadores posibles: 0 - (predeterminado) Me gusta; 1 - Igual; 2 - No me gusta; 3 - No es igual 4 - Existe; 5 - No existe. |
| eventid_from | string | Devuelve solo eventos con ID mayores o iguales al ID proporcionado. |
| eventid_till | string | Devuelve solo eventos con ID menores o iguales al ID proporcionado. |
| time_from | marca de tiempo | Devuelve solo los eventos que se han creado después o en el momento dado. |
| time_till | marca de tiempo | Devuelve solo los eventos que se han creado antes o en el momento dado. |
| problem_time_from | marca de tiempo | Devuelve solo eventos que estaban en el estado de problema comenzando con problem_time_from. Se aplica solo si la fuente es un evento desencadenante y el objeto es un desencadenante. Obligatorio si se especifica problem_time_till. |
| problem_time_till | marca de tiempo | Devuelve solo eventos que estaban en estado de problema hasta problem_time_till. Se aplica solo si la fuente es un evento desencadenante y el objeto es un desencadenante. Obligatorio si se especifica problem_time_from. |
| value | entero/matriz | Devuelve solo eventos con los valores dados. |
| selectHosts | query | Devuelve una propiedad hosts con equipos que contienen el objeto que creó el evento. Solo se admite para eventos generados por activadores, elementos 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. |
| select_alerts | query | Devuelve una propiedad alerts con alertas generadas por el evento. Las alertas se clasifican en orden cronológico inverso. |
| select_acknowledges | query | Devuelve una propiedad acknowledges con actualizaciones de eventos. Las actualizaciones de eventos se ordenan en orden cronológico inverso.El objeto de actualización de eventos tiene las siguientes propiedades: acknowledgeid - (string) ID de reconocimiento;userid - (string) ID del usuario que actualizó el evento;eventid-(string)ID del evento actualizado;clock-(timestamp)hora en que se actualizó el evento;message-(string)texto del mensaje;action-(integer)acción de actualización que se realizó ver [event.acknowledge](/manual/api/reference/event/acknowledge); old_severity-(integer)gravedad del evento antes de esta acción de actualización;new_severity-(integer)gravedad del evento después de esta acción de actualización;suppress_until-(timestamp)tiempo hasta que el evento sea suprimido;taskid-(string)ID de la tarea si el evento actual está experimentando un cambio de clasificación;username-(string)nombre de usuario del usuario que actualizó el evento;nombre-(cadena)nombre del usuario que actualizó el evento;apellido-(cadena)apellido del usuario que actualizó el evento.suppression_datacon la lista de mantenimientos activos y supresiones manuales:maintenanceid-(string)ID del mantenimiento;userid-(string)ID del usuario que suprimió el evento;suppress_until-(entero)tiempo hasta que se suprime el evento.| |sortfield|string/array|Ordena el resultado según las propiedades dadas.eventid,objectid,clock.| |countOutput|boolean|Estos parámetros, que son comunes para todos los métodosget`, se describen en detalle en la página comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | booleano |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si se ha utilizado el parámetro
countOutput, pero no se ha utilizado el parámetrogroupBy; - una matriz de objetos con resultados de agregación, si se ha utilizado el parámetro
groupBy.
Ejemplos
Recuperación de eventos de iniciador
Recuperar los últimos eventos del iniciador "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": "Load average is too high (per CPU load over 1.5 for 5m)",
"severity": "0",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"acknowledges": [],
"opdata": "Load averages(1m 5m 15m): (1.6328 3.0522 2.2515), # of 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": "Load average is too high (per CPU load over 1.5 for 5m)",
"severity": "3",
"r_eventid": "20",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"acknowledges": [
{
"acknowledgeid": "1",
"userid": "1",
"clock": "1728657938",
"message": "Testing environment. Please disregard this alert.",
"action": "38",
"old_severity": "0",
"new_severity": "0",
"suppress_until": "1728744338",
"taskid": "0",
"username": "Admin",
"name": "Zabbix",
"surname": "Administrator"
}
],
"opdata": "Load averages(1m 5m 15m): (1.6328 3.0522 2.2515), # of 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
Recupera todos los eventos que se han creado entre el 9 y 10 de octubre de 2012, en orden cronológico inverso.
{
"jsonrpc": "2.0",
"method": "event.get",
"params": {
"output": "extend",
"time_from": "1349797228",
"time_till": "1350661228",
"sortfield": ["clock", "eventid"],
"sortorder": "desc"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"eventid": "20616",
"source": "0",
"object": "0",
"objectid": "14282",
"clock": "1350477814",
"value": "1",
"acknowledged": "0",
"ns": "0",
"name": "Less than 25% free in the history cache",
"severity": "3",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"opdata": "",
"suppressed": "0",
"urls": []
},
{
"eventid": "20617",
"source": "0",
"object": "0",
"objectid": "14283",
"clock": "1350477814",
"value": "0",
"acknowledged": "0",
"ns": "0",
"name": "Zabbix trapper processes more than 75% busy",
"severity": "3",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"opdata": "",
"suppressed": "0",
"urls": []
},
{
"eventid": "20618",
"source": "0",
"object": "0",
"objectid": "14284",
"clock": "1350477815",
"value": "1",
"acknowledged": "0",
"ns": "0",
"name": "High ICMP ping loss",
"severity": "3",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"opdata": "",
"suppressed": "0",
"urls": []
}
],
"id": 1
}Recuperar eventos reconocidos por el usuario especificado
Recuperando 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": "1248566",
"source": "0",
"object": "0",
"objectid": "15142",
"clock": "1472457242",
"ns": "209442442",
"r_eventid": "1245468",
"r_clock": "1472457285",
"r_ns": "125644870",
"correlationid": "0",
"userid": "10",
"name": "Zabbix agent on localhost is unreachable for 5 minutes",
"acknowledged": "1",
"severity": "3",
"cause_eventid": "0",
"acknowledges": [
{
"userid": "10",
"action": "2"
}
],
"opdata": "",
"suppressed": "0",
"urls": []
}
],
"id": 1
}Recuperar iniciadores principales con recuento de eventos problemáticos
Recupere los 5 iniciadores principales que tienen gravedades "Advertencia", "Promedio", "Alta" o "Desastre", junto con el número de eventos problemáticos dentro de un período de tiempo específico.
{
"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
}Ver también
Fuente
CEvent::get() en ui/include/classes/api/services/CEvent.php.