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

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

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

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

La méthode permet de récupérer des alertes en fonction des paramètres donnés.

::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type. Autorisations
pour appeler la méthode peut être révoqué dans les paramètres du rôle utilisateur. Voir [Rôles utilisateur](/manual/web_interface/frontend_sections/users/user_roles)
pour plus d'informations.
:::

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

[comment]: # ({7c3d247f-218fa8cf})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Paramètre|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|alertids|ID/array|Retourne uniquement les alertes avec les ID donnés.|
|actionids|ID/array|Retourne uniquement les alertes générées par les actions données.|
|eventids|ID/array|Retourne uniquement les alertes générées par les événements donnés.|
|groupids|ID/array|Retourne uniquement les alertes générées par des objets des groupes d'hôtes donnés.|
|hostids|ID/array|Retourne uniquement les alertes générées par des objets des hôtes donnés.|
|mediatypeids|ID/array|Retourne uniquement les alertes de message qui ont utilisé les types de média donnés.|
|objectids|ID/array|Retourne uniquement les alertes générées par les objets donnés|
|userids|ID/array|Retourne uniquement les alertes de message qui ont été envoyées aux utilisateurs donnés.|
|eventobject|integer|Retourne uniquement les alertes générées par des événements liés à des objets du type donné.<br><br>Voir l'[`object`](/manual/api/reference/event/object#event) d'événement pour la liste des types d'objet pris en charge.<br><br>Par défaut : 0 - déclencheur.|
|eventsource|integer|Retourne uniquement les alertes générées par des événements du type donné.<br><br>Voir la [`source`](/manual/api/reference/event/object#event) d'événement pour la liste des types d'événement pris en charge.<br><br>Par défaut : 0 - événements de déclencheur.|
|time\_from|timestamp|Retourne uniquement les alertes qui ont été générées après l'heure donnée.|
|time\_till|timestamp|Retourne uniquement les alertes qui ont été générées avant l'heure donnée.|
|selectHosts|query|Retourne une propriété [`hosts`](/manual/api/reference/host/object) avec les données des hôtes qui ont déclenché l'opération d'action.|
|selectMediatypes|query|Retourne une propriété [`mediatypes`](/manual/api/reference/mediatype/object) avec un tableau des types de média qui ont été utilisés pour l'alerte de message.<br><br>Voir [`mediatype.get`](/manual/api/reference/mediatype/get) pour les restrictions selon le type d'utilisateur.|
|selectUsers|query|Retourne une propriété [`users`](/manual/api/reference/user/object) avec un tableau des utilisateurs auxquels le message était adressé.<br><br>Voir [`user.get`](/manual/api/reference/user/get) pour les restrictions selon le type d'utilisateur.|
|sortfield|string/array|Trie le résultat selon les propriétés données.<br><br>Valeurs possibles : `alertid`, `clock`, `eventid`, `mediatypeid`, `sendto`, `status`.|
|countOutput|boolean|Ces paramètres sont décrits dans les [commentaires de référence](/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]: # ({/7c3d247f-218fa8cf})

[comment]: # ({7223bab1-7223bab1})
### Valeurs retournées

`(integer/array)` Retourne soit : 

-   un tableau d'objets ;
-   le nombre d'objets récupérés, si le paramètre countOutput` a été utilisé.

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

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

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

[comment]: # ({57a43812-8d56d57c})
#### Récupérer les alertes par ID d'action

Récupère toutes les alertes générées par l'action "3".

[Requête](/manual/api#performing-requests) :

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

Réponse :

```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": "Déclencheur: Zabbix agent on Linux server is unreachable for 5 minutes: \nÉtat du déclencheur: PROBLEM\nSévérité du déclencheur: Not classified",
            "status": "0",
            "retries": "3",
            "error": "",
            "esc_step": "1",
            "alerttype": "0",
            "p_eventid": "0",
            "acknowledgeid": "0"
        }
    ],
    "id": 1
}
```

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

[comment]: # ({c240ff85-5371aed2})
### Voir aussi

-   [Hôte](/manual/api/reference/host/object#host)
-   [Type de média](/manual/api/reference/mediatype/object#media-type)
-   [Utilisateur](/manual/api/reference/user/object#user)

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

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

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

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