alert.get

Descripción

integer/array alert.get(object parameters)

El método permite recuperar alertas según los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Para más información, ver Roles de usuario.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
alertids ID/array Devolver solo las alertas con los IDs indicados.
actionids ID/array Devolver solo las alertas generadas por las acciones indicadas.
eventids ID/array Devolver solo las alertas generadas por los eventos indicados.
groupids ID/array Devolver solo las alertas generadas por objetos de los grupos de hosts indicados.
hostids ID/array Devolver solo las alertas generadas por objetos de los hosts indicados.
mediatypeids ID/array Devolver solo las alertas de mensaje que utilizaron los tipos de medio indicados.
objectids ID/array Devolver solo las alertas generadas por los objetos indicados
userids ID/array Devolver solo las alertas de mensaje que se enviaron a los usuarios indicados.
eventobject integer Devolver solo las alertas generadas por eventos relacionados con objetos del tipo indicado.

Consulte el evento object para ver una lista de los tipos de objeto admitidos.

Por defecto: 0 - trigger.
eventsource integer Devolver solo las alertas generadas por eventos del tipo indicado.

Consulte el evento source para ver una lista de los tipos de evento admitidos.

Por defecto: 0 - eventos de trigger.
time_from timestamp Devolver solo las alertas que se hayan generado después del momento indicado.
time_till timestamp Devolver solo las alertas que se hayan generado antes del momento indicado.
selectHosts query Devolver una propiedad hosts con los datos de los hosts que activaron la operación de acción.
selectMediatypes query Devolver una propiedad mediatypes con una matriz de los tipos de medio que se utilizaron para la alerta de mensaje.

Consulte mediatype.get para ver las restricciones según el tipo de usuario.
selectUsers query Devolver una propiedad users con una matriz de los usuarios a los que se dirigió el mensaje.

Consulte user.get para ver las restricciones según el tipo de usuario.
sortfield string/array Ordenar el resultado por las propiedades indicadas.

Valores posibles: alertid, clock, eventid, mediatypeid, sendto, status.
countOutput boolean Estos parámetros se describen en el comentario de referencia.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

En Zabbix 7.0.9, los usuarios de tipo Admin y User solo pueden recuperar datos de alertas de tipo "message" (0) sobre su propio usuario.

Valores de devueltos

(integer/array) Devuelve:

  • una matriz de objetos;
  • la suma de los objetos devueltos, si el parámetro countOutput está siendo usado

Ejemplos

Recuperar alertas por ID de acción

Recupera todas las alertas generadas por la acción "3".

Solicitud:

{
"jsonrpc": "2.0",
"method": "alert.get",
"params": {
"output": "extend",
"actionids": "3"
},
"id": 1
}

Response:

{
"jsonrpc": "2.0",
"result": [
{
"alertid": "1",
"actionid": "3",
"eventid": "21243",
"userid": "1",
"clock": "1362128008",
"mediatypeid": "1",
"sendto": "[email protected]",
"subject": "PROBLEM: Zabbix agent on Linux server is unreachable for 5 minutes: ",
"message": "Trigger: Zabbix agent on Linux server is unreachable for 5 minutes: \nTrigger status: PROBLEM\nTrigger severity: Not classified",
"status": "0",
"retries": "3",
"error": "",
"esc_step": "1",
"alerttype": "0",
"p_eventid": "0",
"acknowledgeid": "0"
}
],
"id": 1
}

Ver también

Fuente

CAlert::get() en ui/include/classes/api/services/CAlert.php.