Documentation
Table of Contents
alert.get
Description
integer/array alert.get(object param¨¨tres)
La m¨¦thode permet de r¨¦cup¨¦rer des alertes en fonction des param¨¨tres sp¨¦cifi¨¦s.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| alertids | string/array | Renvoie uniquement les alertes avec les IDs sp¨¦cifi¨¦s. |
| actionids | string/array | Renvoie uniquement les alertes g¨¦n¨¦r¨¦es par les IDs d'action sp¨¦cifi¨¦s. |
| eventids | string/array | Renvoie uniquement les alertes g¨¦n¨¦r¨¦es par les IDs d'¨¦v¨¨nement sp¨¦cifi¨¦s. |
| groupids | string/array | Renvoie uniquement les alertes g¨¦n¨¦r¨¦es par les objets des IDs des groupes d'h?tes sp¨¦cifi¨¦s. |
| hostids | string/array | Renvoie uniquement les alertes g¨¦n¨¦r¨¦es par les IDs d'h?te sp¨¦cifi¨¦s. |
| mediatypeids | string/array | Renvoie uniquement les alertes utilisant les IDs de type de m¨¦dia sp¨¦cifi¨¦s. |
| objectids | string/array | Renvoie uniquement les alertes g¨¦n¨¦r¨¦es par les IDs d'objet sp¨¦cifi¨¦s. |
| userids | string/array | Renvoie uniquement les alertes transmises aux utilisateurs sp¨¦cifi¨¦s. |
| eventobject | integer | Renvoie uniquement les alertes g¨¦n¨¦r¨¦es par les ¨¦v¨¦nements li¨¦s aux objets du type sp¨¦cifi¨¦. Se r¨¦f¨¦rer ¨¤ la propri¨¦t¨¦ "object" de l'¨¦v¨¨nement pour une liste des types d'objet pris en charge. Par d¨¦faut: 0 - d¨¦clencheur. |
| eventsource | integer | Renvoie uniquement les alertes g¨¦n¨¦r¨¦es par les ¨¦v¨¦nements du type sp¨¦cifi¨¦. Se r¨¦f¨¦rer ¨¤ la propri¨¦t¨¦ "source" de l'¨¦v¨¨nement pour une liste des types d'¨¦v¨¦nement pris en charge. Par d¨¦faut: 0 - ¨¦v¨¨nements d¨¦clench¨¦s. |
| time_from | timestamp | Renvoie uniquement les alertes g¨¦n¨¦r¨¦es apr¨¨s l'heure sp¨¦cifi¨¦e. |
| time_till | timestamp | Renvoie uniquement les alertes g¨¦n¨¦r¨¦es avant l'heure sp¨¦cifi¨¦e. |
| selectHosts | query | Renvoie les h?tes ayant d¨¦clench¨¦ l'op¨¦ration d'action dans la propri¨¦t¨¦ hosts. |
| selectMediatypes | query | Renvoie le(s) type(s) de m¨¦dia utilis¨¦(s) pour le message d'alerte sous forme de tableau dans la propri¨¦t¨¦ mediatypes. |
| selectUsers | query | Renvoie le(s) utilisateur(s) au(x)quel(s) le message a ¨¦t¨¦ adress¨¦ en tant que tableau dans la propri¨¦t¨¦ users. |
| sortfield | string/array | Trier le r¨¦sultat par les propri¨¦t¨¦s sp¨¦cifi¨¦es. Valeurs possibles: alertid, clock, eventid et status. |
| countOutput | boolean | Ces param¨¨tres, communs ¨¤ toutes les m¨¦thodes "get", sont d¨¦crits dans les commentaires 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 de retour
(integer/array) Retourne soit:
- un tableau d'objets;
- le nombre d'objets r¨¦cup¨¦r¨¦s, si le param¨¨tre
countOutputa ¨¦t¨¦ utilis¨¦.
Exemples
R¨¦cup¨¦rer des alertes par ID d'action
R¨¦cup¨¦rer toutes les alertes g¨¦n¨¦r¨¦es par l'action "3".
¸é±ð±ç³Ü¨º³Ù±ð:
{
"jsonrpc": "2.0",
"method": "alert.get",
"params": {
"output": "extend",
"actionids": "3"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}¸é¨¦±è´Ç²Ô²õ±ð:
{
"jsonrpc": "2.0",
"result": [
{
"alertid": "1",
"actionid": "3",
"eventid": "21243",
"userid": "1",
"clock": "1362128008",
"mediatypeid": "1",
"sendto": "[email protected]",
"subject": "PROBLEM: Áú»¢¶Ä²© agent on Linux server is unreachable for 5 minutes: ",
"message": "Trigger: Áú»¢¶Ä²© 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() dans frontends/php/include/classes/api/services/CAlert.php.