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

Parameter Type Description
alertids ID/array Devuelve solo alertas con los IDs dados.
actionids ID/array Devuelve solo alertas generadas por las acciones dadas.
eventids ID/array Devuelve solo alertas generadas por los eventos dados.
groupids ID/array Devuelve solo alertas generadas por objetos de los grupos de host dados.
hostids ID/array Devuelve solo alertas generadas por objetos de los hosts dados.
mediatypeids ID/array Devuelve solo alertas de mensaje que usaron los tipos de medio dados.
objectids ID/array Devuelve solo alertas generadas por los objetos dados
userids ID/array Devuelve solo alertas de mensaje que se enviaron a los usuarios dados.
eventobject integer Devuelve solo alertas generadas por eventos relacionados con objetos del tipo dado.

Consulte event object para obtener una lista de los tipos de objeto admitidos.

Predeterminado: 0 - trigger.
eventsource integer Devuelve solo alertas generadas por eventos del tipo dado.

Consulte event source para obtener una lista de los tipos de evento admitidos.

Predeterminado: 0 - eventos de trigger.
time_from timestamp Devuelve solo alertas que se hayan generado después de la hora dada.
time_till timestamp Devuelve solo alertas que se hayan generado antes de la hora dada.
selectHosts query Devuelve una propiedad hosts con datos de los hosts que activaron la operación de la acción.
selectMediatypes query Devuelve una propiedad mediatypes con un array de los tipos de medio que se usaron para la alerta de mensaje.

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

Consulte user.get para conocer las restricciones según el tipo de usuario.
sortfield string/array Ordena el resultado por las propiedades dadas.

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 pueden recuperar datos de alertas de tipo "message" (0) solo sobre su propio usuario.

Valores de retorno

(integer/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar alertas por ID de acción

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

Request:

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

Respuesta:

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