alert.get

Description

integer/array alert.get(object parameters)

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

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 pour plus d'informations.

Paramètres

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

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

Paramètre Type Description
alertids ID/array Retourner uniquement les alertes avec les ID donnés.
actionids ID/array Retourner uniquement les alertes générées par les actions données.
eventids ID/array Retourner uniquement les alertes générées par les événements donnés.
groupids ID/array Retourner uniquement les alertes générées par des objets provenant des groupes d’hôtes donnés.
hostids ID/array Retourner uniquement les alertes générées par des objets provenant des hôtes donnés.
mediatypeids ID/array Retourner uniquement les alertes de message ayant utilisé les types de média donnés.
objectids ID/array Retourner uniquement les alertes générées par les objets donnés
userids ID/array Retourner uniquement les alertes de message qui ont été envoyées aux utilisateurs donnés.
eventobject integer Retourner uniquement les alertes générées par des événements liés à des objets du type donné.

Voir l’object d’événement pour une liste des types d’objets pris en charge.

Par défaut : 0 - déclencheur.
eventsource integer Retourner uniquement les alertes générées par des événements du type donné.

Voir la source d’événement pour une liste des types d’événements pris en charge.

Par défaut : 0 - événements de déclencheur.
time_from timestamp Retourner uniquement les alertes qui ont été générées après l’heure donnée.
time_till timestamp Retourner uniquement les alertes qui ont été générées avant l’heure donnée.
selectHosts query Retourner une propriété hosts avec les données des hôtes qui ont déclenché l’opération d’action.
selectMediatypes query Retourner une propriété mediatypes avec un tableau des types de média qui ont été utilisés pour l’alerte de message.

Voir mediatype.get pour les restrictions selon le type d’utilisateur.
selectUsers query Retourner une propriété users avec un tableau des utilisateurs auxquels le message était adressé.

Voir user.get pour les restrictions selon le type d’utilisateur.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : alertid, clock, eventid, mediatypeid, sendto, status.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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é.

Exemples

Récupérer les alertes par ID d'action

Récupérez toutes les alertes générées par l'action « 3 ».

Requête:

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

Réponse :

{
    "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 state: PROBLEM\nTrigger severity: Not classified",
            "status": "0",
            "retries": "3",
            "error": "",
            "esc_step": "1",
            "alerttype": "0",
            "p_eventid": "0",
            "acknowledgeid": "0"
        }
    ],
    "id": 1
}

Voir également

Source

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