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 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 del rol 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.

Parameter Type Description
eventids ID/array Devuelve solo eventos con los IDs dados.
groupids ID/array Devuelve solo eventos creados por objetos que pertenecen a los grupos de hosts dados.
hostids ID/array Devuelve solo eventos creados por objetos que pertenecen a los hosts dados.
objectids ID/array Devuelve solo eventos creados por los objetos dados.
source integer Devuelve solo eventos con el tipo dado.

Consulte la página del objeto event para obtener una lista de los tipos de evento admitidos.

Predeterminado: 0 - eventos de trigger.
object integer Devuelve solo eventos creados por objetos del tipo dado.

Consulte la página del objeto event para obtener una lista de los tipos de objeto admitidos.

Predeterminado: 0 - trigger.
acknowledged boolean Si se establece en true, devuelve solo eventos reconocidos.
action integer Devuelve solo eventos para los que se han realizado las acciones de actualización de evento dadas. Para varias acciones, use la suma de cualquier valor de bitmap aceptable como máscara de bits (por ejemplo, 34 para reconocer y suprimir el evento).
action_userids ID/array Devuelve solo eventos con los IDs dados de los usuarios que realizaron las acciones de actualización del evento.
suppressed boolean Si se establece en true, devuelve solo eventos suprimidos.
symptom boolean Si se establece en true, devuelve solo eventos de síntoma.
severities integer/array Devuelve solo eventos con las severidades de evento dadas. Se aplica solo si object es trigger.
trigger_severities integer/array Devuelve solo eventos con las severidades de trigger dadas. Se aplica solo si object es trigger.
evaltype integer Método de evaluación de etiquetas.

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

Valores posibles de operator:
0 - (predeterminado) Contiene;
1 - Igual a;
2 - No contiene;
3 - No es igual a;
4 - Existe;
5 - No existe.
eventid_from string Devuelve solo eventos con IDs mayores o iguales al ID dado.
eventid_till string Devuelve solo eventos con IDs menores o iguales al ID dado.
time_from timestamp Devuelve solo eventos creados en o después de la hora dada.
time_till timestamp Devuelve solo eventos creados en o antes de la hora dada.
problem_time_from timestamp Devuelve solo eventos que estuvieron en estado de problema desde problem_time_from, independientemente de su estado actual. Se aplica solo cuando la fuente es un evento de trigger y el objeto es un trigger. Este parámetro es obligatorio si se especifica problem_time_till.
problem_time_till timestamp Devuelve solo eventos que estuvieron en estado de problema hasta problem_time_till, independientemente de su estado actual. Se aplica solo cuando la fuente es un evento de trigger y el objeto es un trigger. Este parámetro es obligatorio si se especifica problem_time_from.
value integer/array Devuelve solo eventos con los valores dados.
selectAcknowledges query 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 del 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 que se realizó, consulte 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.

Admite 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 hosts que contienen el objeto que creó el evento. Solo se admite para eventos generados por triggers, items 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) tiempo hasta el que el evento está suprimido.
selectTags query Devuelve una propiedad tags con las etiquetas del evento.
filter object Devuelve solo aquellos resultados que coinciden exactamente con el filtro dado.

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 datos data type text.
sortfield string/array Ordena el resultado por las propiedades dadas.

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 dadas. 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
select_acknowledges
(deprecated)		 query Este parámetro está obsoleto, use selectAcknowledges en su lugar.
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 del 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 que se realizó, consulte 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.

Admite count.
select_alerts
(deprecated)		 query Este parámetro está obsoleto, use selectAlerts en su lugar.
Devuelve una propiedad alerts con las alertas generadas por el evento.
Las alertas se ordenan en orden cronológico inverso.

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ámetro groupBy;
  • 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".

Solicitud:

{
    "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 periodo de tiempo

Recuperar todos los eventos que se han creado entre el 17 y el 18 de octubre de 2012, en orden cronológico inverso.

Solicitud:

{
    "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": "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": "20616",
            "source": "0",
            "object": "0",
            "objectid": "14281",
            "clock": "1350477814",
            "value": "0",
            "acknowledged": "0",
            "ns": "0",
            "name": "Zabbix trapper processes more than 75% busy",
            "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": "Zabbix trapper processes more than 75% busy",
            "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

Solicitud:

{
    "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 triggers principales con el recuento de eventos de problema

Recuperar los 5 triggers principales que tienen las severidades "Warning", "Average", "High" o "Disaster", junto con el número de eventos de problema dentro de un período de tiempo especificado.

Solicitud:

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