[comment]: # ({4c82c7ad-4c82c7ad})
# alert.get

[comment]: # ({/4c82c7ad-4c82c7ad})

[comment]: # ({3c5ac067-ed55724c})
### Descripción

`integer/array alert.get(object parameters)`

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

::: noteclassic
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](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/3c5ac067-ed55724c})

[comment]: # ({9bc7f5ce-218fa8cf})
### Parámetros

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

El método admite los siguientes parámetros.

|Parámetro|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|alertids|string/array|Devuelve solo alertas con los ID proporcionados.|
|actionids|string/array|Devuelve solo alertas generadas por las acciones dadas.|
|eventids|cadena/matriz|Devuelve solo alertas generadas por los eventos dados.|
|groupids|cadena/matriz|Devuelve solo alertas generadas por objetos de los grupos de hosts dados.|
|hostids|cadena/matriz|Devuelve solo alertas generadas por objetos de los hosts dados.|
|mediatypeids|cadena/matriz|Devolver solo alertas de mensajes que utilizaron los tipos de medios dados.|
|objectids|cadena/matriz|Devolver solo alertas generadas por los objetos dados|
|userids|cadena/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.<br><br>Consulte evento ["object"](/manual/api/reference/event/object#event) para obtener una lista de tipos de objetos admitidos.<br><br>Predeterminado: 0 - activador.|
|eventsource|integer|Devuelve solo alertas generadas por eventos del tipo dado.<br><br>Consulte event ["source"](/manual/api/reference/event/object#event) para obtener una lista de los tipos de eventos admitidos .<br><br>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](/manual/api/reference/host/object) con datos de los hosts que desencadenaron la operación de acción.|
|selectMediatypes|query|Devuelve una propiedad [mediatypes](/manual/api/reference/mediatype/object) con una matriz de los tipos de medios que se utilizaron para la alerta del mensaje.|
|selectUsers|query|Devuelve una propiedad [usuarios](/manual/api/reference/user/object) con una matriz de los usuarios a los que se dirigió el mensaje.|
|sortfield|string/array|Ordena el resultado por las propiedades dadas.<br><br>Valores posibles: `alertid`, `clock`, `eventid`, `mediatypeid`, `sendto`, `status`.|
|countOutput|boolean|Estos parámetros, que son comunes para todos los métodos `get`, se describen en el [comentario de referencia](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|booleano|^|
|excludeSearch|booleano|^|
|filter|objeto|^|
|limit|entero|^|
|output|consulta|^|
|preservekeys|booleano|^|
|search|objeto|^|
|searchByAny|booleano|^|
|searchWildcardsEnabled|booleano|^|
|sortorderstartSearch|cadena/matriz|^|
|startSearch|booleano|^|

[comment]: # ({/9bc7f5ce-218fa8cf})

[comment]: # ({7223bab1-7223bab1})
### Valores de devueltos

`(integer/array)` Devuelve:

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

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Ejemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({57a43812-8d56d57c})
#### Recuperar alertas por ID de acción

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

[Solicitud](/manual/api#performing-requests):

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

Response:

```json
{
"jsonrpc": "2.0",
"result": [
{
"alertid": "1",
"actionid": "3",
"eventid": "21243",
"userid": "1",
"clock": "1362128008",
"mediatypeid": "1",
"sendto": "support@company.com",
"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
}
```

[comment]: # ({/57a43812-8d56d57c})

[comment]: # ({5371aed2-5371aed2})
### Ver también

-   [Equipo](/manual/api/reference/host/object#host)
-   [Tipo de Medio](/manual/api/reference/mediatype/object#media_type)
-   [Usuario](/manual/api/reference/user/object#user)

[comment]: # ({/5371aed2-5371aed2})

[comment]: # ({14a85885-14a85885})
### Fuente

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

[comment]: # ({/14a85885-14a85885})