Documentation
Table of Contents
alert.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
integer/array alert.get(object parameters)
El m¨¨tode permet recuperar alertes segons els par¨¤metres prove?ts.
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.
±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ
(object) ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ que defineixen la sortida esperada.
Aquest m¨¨tode suporta els par¨¤metres seg¨¹ents.
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| alertids | ID/array | Retorna nom¨¦s alertes amb els IDs especificats. |
| actionids | ID/array | Retorna nom¨¦s alertes generades per les accions especificades. |
| eventids | ID/array | Retorna nom¨¦s alertes generades per els events especificats. |
| groupids | ID/array | Retorna nom¨¦s alertes generades per objectes dels grups d'equips especificats. |
| hostids | ID/array | Retorna nom¨¦s alertes generades per objectes dels equips especificats. |
| mediatypeids | ID/array | Retorna nom¨¦s missatges d'alertes que empren els tipus de mitjans especificats. |
| objectids | ID/array | Retorna nom¨¦s alertes generades per els objectes especificats. |
| userids | ID/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. Veieu l'event "object" for a list of supported object types. Per defecte: 0 - trigger. |
| eventsource | integer | Retorna nom¨¦s alertes generades per events del tipus especificat. Veieu l'esdeveniment "source" per obtindre una llista dels tipus d'events suportats. 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 amb informaci¨® dels equips que han executat el trigger d'operaci¨® d'acci¨®. |
| selectMediatypes | query | Retorna la propietat mediatypes amb una matriu dels tipus de suport que s'han emprat per al missatge d'alerta. Veieu mediatype.get per sapiguer sobre restriccions basades en tipus d'usuari. |
| selectUsers | query | Retorna la propietat users amb una matriu dels usuaris als qui el missatge fou adre?at. |
| sortfield | string/array | Ordena el resultat per les propietats especificades. Possible values are: alertid, clock, eventid, mediatypeid, sendto i status. |
| countOutput | boolean | Aquesta par¨¤metres s¨®n descrits al comentari de refer¨¨ncia. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
A Áú»¢¶Ä²© 7.2.3, els usuaris de tipus Administrador i Usuari poden recuperar dades d'alerta de tipus "missatge" (0) nom¨¦s sobre el seu propi usuari.
Valors de retorn
(integer/array) Retorna:
- una matriu d'objectes;
- el recompte dels objectes recuperats, si s'ha emprat el par¨¤metre
countOutput.
Exemples
Recuperar les alertes per l'ID d'acci¨®
Recuperar totes les alertes generades per l'acci¨® "3".
{
"jsonrpc": "2.0",
"method": "alert.get",
"params": {
"output": "extend",
"actionids": "3"
},
"id": 1
}Resposta:
{
"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
}Veieu tamb¨¦
Font
CAlert::get() in ui/include/classes/api/services/CAlert.php.