alert.get

Description

integer/array alert.get(paramètres d'objet)

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

Cette méthode est disponible pour tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres des rôles utilisateur. Voir Rôles utilisateur pour plus d'informations.

Paramètres

(object) Parameters defining the desired output.

The method supports the following parameters.

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

Voir event "object" pour une liste des types d'objets pris en charge.

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

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

Par défaut : 0 - événements déclencheurs.
time_from timestamp Renvoyer uniquement les alertes qui ont été générées après l'heure donnée.
time_till timestamp Renvoyer uniquement les alertes qui ont été générées avant l'heure indiquée.
selectHosts query Renvoie une propriété hosts avec les données des hôtes qui ont déclenché l'opération d'action.
selectMediatypes query Renvoie une propriété mediatypes avec un tableau des types de médias qui ont été utilisés pour l'alerte de message.
selectUsers query Renvoie une propriété users avec un tableau des utilisateurs auxquels le message a été adressé.
sortfield string/array Trier le résultat selon les propriétés données.

Les valeurs possibles sont : alertid, clock, eventid, mediatypeid, sendto et status.
countOutput boolean Ces paramètres étant communs à toutes les méthodes get sont décrits dans le commentaire de référence.
modifiable booléen
excludeSearch booléen
filtre objet
limite integer
sortie query
preservekeys boolean
recherche object
searchByAny boolean
searchWildcardsEnabled boolean
ordredetri 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 identifiant d'action

Récupérer tous les alertes générées par l'action "3".

Requête :

{
           "jsonrpc": "2.0",
           "method": "alert.get",
           "params": {
               "output": "extend",
               "actionids": "3"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "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 status: 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.