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

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

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
alertids ID/matriz Devuelve solo alertas con los ID proporcionados.
actionids ID/array Devuelve solo alertas generadas por las acciones dadas.
eventids ID/matriz Devuelve solo alertas generadas por los eventos dados.
groupids ID/matriz Devuelve sólo alertas generadas por objetos de los grupos de equipos dados.
hostids ID/matriz Devuelve sólo alertas generadas por objetos de los equipos dados.
mediatypeids ID/matriz Devolver solo alertas de mensajes que utilizaron los tipos de medios dados.
objectids ID/matriz Devolver solo alertas generadas por los objetos dados
userids ID/matriz Devolver solo alertas de mensajes que se enviaron a los usuarios indicados.
eventobject integer Devuelve solo alertas generadas por eventos relacionados con objetos del tipo dado.

Consulte evento object para obtener una lista de tipos de objetos admitidos.

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

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

Predeterminado: 0 - desencadena eventos.
time_from timestamp Devuelve solo las alertas que se han generado después del tiempo indicado.
time_till timestamp Devuelve solo las alertas que se han generado antes de la hora indicada.
selectHosts query Devuelve una propiedad hosts con datos de los equipos que desencadenaron la operación de acción.
selectMediatypes query Devuelve una propiedad mediatypes con una matriz de los tipos de medios que se usaron para la alerta del mensaje.
selectUsers query Devuelve una propiedad users con una matriz de los usuarios a los que se dirigió el mensaje.
sortfield string/array Ordena el resultado por las propiedades dadas.

Valores posibles: alertid, clock, eventid, mediatypeid, sendto, status.
countOutput booleano Estos parámetros, que son comunes para todos los métodos get, se describen en el 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 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.