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.
(objeto)
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 alertas con los IDs indicados. |
actionids | ID/array | Devolver solo alertas generadas por las acciones indicadas. |
eventids | ID/array | Devolver solo alertas generadas por los eventos indicados. |
groupids | ID/array | Devolver solo alertas generadas por objetos de los grupos de hosts indicados. |
hostids | ID/array | Devolver solo alertas generadas por objetos de los hosts indicados. |
mediatypeids | ID/array | Devolver solo alertas de mensajes que usaron los tipos de medio indicados. |
objectids | ID/array | Devolver solo alertas generadas por los objetos indicados |
userids | ID/array | Devolver solo alertas de mensajes que se enviaron a los usuarios indicados. |
eventobject | entero | Devolver solo 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 - disparador. |
eventsource | entero | Devolver solo 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 disparador. |
time_from | timestamp | Devolver solo alertas que se hayan generado después del tiempo indicado. |
time_till | timestamp | Devolver solo alertas que se hayan generado antes del tiempo indicado. |
selectHosts | consulta | Devolver una propiedad hosts con los datos de los hosts que activaron la operación de acción. |
selectMediatypes | consulta | Devolver una propiedad mediatypes con una matriz de los tipos de medio que se usaron para la alerta de mensaje.Consulte mediatype.get para restricciones basadas en el tipo de usuario. |
selectUsers | consulta | Devolver una propiedad users con una matriz de los usuarios a los que se dirigió el mensaje.Consulte user.get para restricciones basadas en el tipo de usuario. |
sortfield | string/array | Ordenar el resultado por las propiedades indicadas. Valores posibles: alertid , clock , eventid , mediatypeid , sendto , status . |
countOutput | booleano | Estos parámetros 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 | string/array | |
startSearch | booleano |
(integer/array)
Devuelve:
countOutput
está siendo usadoRecupera todas las alertas generadas por la acción "3".
{
"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
}
CAlert::get() en ui/include/classes/api/services/CAlert.php.