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

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

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

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

El mètode permet recuperar alertes segons els paràmetres proveïts.

::: noteclassic
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu [Rols d'usuari](/manual/web_interface/frontend_sections/users/user_roles).
:::

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

[comment]: # ({9bc7f5ce-218fa8cf})
### Paràmetres

`(object)` Paràmetres que defineixen la sortida esperada.

Aquest mètode suporta els paràmetres següents.

|Paràmetre|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|alertids|string/array|Retorna només alertes amb els IDs especificats.|
|actionids|string/array|Retorna només alertes generades per les accions especificades.|
|eventids|string/array|Retorna només alertes generades per els events especificats.|
|groupids|string/array|Retorna només alertes generades per objectes dels grups d'equips especificats.|
|hostids|string/array|Retorna només alertes generades per objectes dels equips especificats.|
|mediatypeids|string/array|Retorna només missatges d'alertes que empren els tipus de mitjans especificats.|
|objectids|string/array|Retorna només alertes generades per els objectes especificats.|
|userids|string/array|Retorna només missatges d'alertes que es van enviar als usuaris especificats.|
|eventobject|integer|Retorna només alertes generades per events relacionats amb els objectes dels tipus especificats.<br><br>Veieu l'event ["object"](/manual/api/reference/event/object#event) for a list of supported object types.<br><br>Per defecte: 0 - trigger.|
|eventsource|integer|Retorna només alertes generades per events del tipus especificat.<br><br>Veieu l'esdeveniment ["source"](/manual/api/reference/event/object#event) per obtindre una llista dels tipus d'events suportats.<br><br>Per defecte: 0 - esdeveniments de triggers.|
|time\_from|timestamp|Retorna només alertes generades per després de l'hora especificada.|
|time\_till|timestamp|Retorna només alertes generades abans de l'hora especificada.|
|selectHosts|query|Retorna la propietat [equips](/manual/api/reference/host/object) amb informació dels equips que han executat el trigger d'operació d'acció.|
|selectMediatypes|query|Retorna la propietat [mediatypes](/manual/api/reference/mediatype/object) amb una matriu dels tipus de mitjans que s'han emprat per al missatge d'alerta.|
|selectUsers|query|Retorna la propietat [users](/manual/api/reference/user/object) amb una matriu dels usuaris als qui el missatge fou adreçat.|
|sortfield|string/array|Ordena el resultat per les propietats especificades.<br><br>Possible values are: `alertid`, `clock`, `eventid`, `mediatypeid`, `sendto` i `status`.|
|countOutput|boolean|Aquesta paràmetres són els comuns per a tots els mètodes `get`, i són descrits al [comentari de referència](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

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

[comment]: # ({7223bab1-7223bab1})
### Valors de retorn

`(integer/array)` Retorna:

- una matriu d'objectes;
- el recompte dels objectes recuperats, si s'ha emprat el paràmetre `countOutput`.

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

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

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

[comment]: # ({57a43812-8d56d57c})
#### Recuperar les alertes per l'ID d'acció

Recuperar totes les alertes generades per l'acció "3".

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

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

Resposta:

```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})
### Veieu també

-   [Equip](/manual/api/reference/host/object#host)
-   [Tipus de mitjà](/manual/api/reference/mediatype/object#media_type)
-   [Usuari](/manual/api/reference/user/object#user)

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

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

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

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