Documentation
Table of Contents
event.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
integer/array event.get(object parameters)
El m¨¨tode permet recuperar esdeveniments segons els par¨¤metres prove?ts.
Aquest m¨¨tode retorna esdeveniments d'una entitat esborrada si aquests esdeveniments no han estat esborrat per el proc¨¦s de neteja.
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.
El m¨¨tode admet els par¨¤metres seg¨¹ents.
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| eventids | ID/array | Retorna nom¨¦s esdeveniments amb els identificadors donats. |
| groupids | ID/array | Retorna nom¨¦s esdeveniments creats per objectes que pertanyen als grups d'equips donats. |
| hostids | ID/array | Retorna nom¨¦s els esdeveniments creats per objectes que pertanyen als equips donats. |
| objectids | ID/array | Retorna nom¨¦s els esdeveniments creats pels objectes donats. |
| source | integer | Retorna nom¨¦s esdeveniments amb el tipus donat. Consulteu la p¨¤gina d'objectes d'esdeveniment per obtindre una llista dels tipus d'esdeveniments compatibles. Per defecte: 0 - desencadena esdeveniments. |
| object | integer | Retorna nom¨¦s els esdeveniments creats per objectes del tipus donat. Consulteu a P¨¤gina d'objectes d'esdeveniment per obtindre una llista dels admesos. tipus d'esdeveniment. Per defecte: 0 - trigger. |
| acknowledged | boolean | Si es defineix com a true, nom¨¦s retorna els esdeveniments reconeguts. |
| action | integer | Retorna nom¨¦s els esdeveniments per als que s'han executat les accions d'actualitzaci¨® d'esdeveniment. Per accions m¨²ltiples, empreu una combinaci¨® de qualsevol valor acceptable de bitmaps com a m¨¤scara de bits (per exemple, 34 per reconeixer i esborrar un esdeveniment). |
| action_userids | ID/array | Retorna nom¨¦s els esdeveniments amb els IDs donats d'usuaris que han fet accions d'actualitzaci¨® d'esdeveniments. |
| suppressed | boolean | true - Retorna nom¨¦s esdeveniments esborrats;false - Retorna nom¨¦s esdeveniments esborrats amb un estat normal. |
| symptom | boolean | true - retorna nom¨¦s els esdeveniments simptom¨¤tics;false - retorna nom¨¦s els esdeveniments causa. |
| severities | integer/array | Retorna nom¨¦s esdeveniments amb gravetats donades. S'aplica nom¨¦s si l'objecte ¨¦s un trigger. |
| trigger_severities | integer/array | Retorna nom¨¦s els esdeveniments amb la gravetat de trigger donada. Aplica nom¨¦s si l'objecte ¨¦s un trigger. |
| evaltype | integer | Regles per a la cerca d'etiquetes. Valors possibles: 0 - (per defecte) i/o; 2 - o. |
| tags | array of object | Retorna nom¨¦s esdeveniments amb etiquetes donades. Concordan?a exacta per etiqueta i cerca sense distinci¨® entre maj¨²scules i min¨²scules per valor i operador. Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Una matriu buida retorna tots els esdeveniments. Tipus d'operadors possibles: 0 - (per defecte) Com; 1 - Igual; 2 - No ¨¦s com; 3 - No ¨¦s igual 4 - Existeix; 5 - No existeix. |
| eventid_from | string | Retorna nom¨¦s esdeveniments l'identificador dels quals ¨¦s superior o igual a l'identificador donat. |
| eventid_till | string | Retorna nom¨¦s esdeveniments l'identificador dels quals ¨¦s menor o igual que l'identificador donat. |
| time_from | timestamp | Retorna nom¨¦s els esdeveniments creats despr¨¦s o a l'hora especificada. |
| time_till | timestamp | Retorna nom¨¦s els esdeveniments creats abans o a l'hora especificada. |
| problem_time_from | timestamp | Retorna nom¨¦s els esdeveniments que eren en estat de problema des de problem_time_from. S'aplica nom¨¦s si la font ¨¦s un esdeveniment trigger i l'objecte ¨¦s un trigger. Obligatori si s'especifica problem_time_till. |
| problem_time_till | timestamp | Retorna nom¨¦s els esdeveniments que eren en estat de problema fins a problem_time_till. S'aplica nom¨¦s si la font ¨¦s un esdeveniment trigger i l'objecte ¨¦s un trigger. Obligatori si s'especifica problem_time_from. |
| value | integer/array | Retorna nom¨¦s esdeveniments amb els valors donats. |
| selectAcknowledges | query | Retorna una propietat acknowledges amb actualitzacions d'esdeveniments. Les actualitzacions d'esdeveniments s¨®n endre?ades en ordre cronol¨°gic invers.L'objecte t¨¦ les propietats seg¨¹ents: acknowledgeid - (ID) IDs del reconeixement;userid - (ID) ID de l'usuari que ha actualitzat l'esdeveniment;clock - (timestamp) l'hora quan es va actualitzar l'esdeveniment;message - (string) text del missatge;action - (integer) ²¹³¦³¦¾±¨® d'actualitzaci¨® que s'ha executat; veieu event.acknowledge;old_severity - (integer) gravetat de l'esdeveniment abans d'aquesta ²¹³¦³¦¾±¨® d'actualitzaci¨®;new_severity - (integer) gravetat de l'esdeveniment despr¨¦s d'aquesta ²¹³¦³¦¾±¨® d'actualitzaci¨®;suppress_until - (timestamp) temps des que l'esdeveniment ser¨¤ esborrat;taskid - (ID) ID de la tasca si l'esdeveniment actual t¨¦ un canvi de classificaci¨®;username - (string) nom d'usuari qui ha actualitzat l'esdeveniment;name - (string) nom de l'usuari que actualitza l'esdeveniment;surname - (string) cognom de l'usuari que actualitza l'esdeveniment.Admet count. |
| selectAlerts | query | Retorna una propietat alerts amb les alertes generades per l'esdeveniment. Les alertes s'ordenen en ordre cronol¨°gic invers. |
| selectHosts | query | Retorna una propietat hosts amb els equips que contenen l'objecte que va crear l'esdeveniment. Nom¨¦s s'admet per a esdeveniments generats per triggers, elements o regles de descobriment de baix nivell. |
| selectRelatedObject | query | Retorna una propietat relatedObject amb l'objecte que va crear l'esdeveniment a la propietat. El tipus d'objecte retornat dep¨¨n del tipus d'esdeveniment. |
| selectSuppressionData | query | Retorna una propietat suppression_data amb la llista de manteniments:maintenanceid - (string) ID de manteniment;;userid - (ID) ID de l'usuari qui ha esborrat l'esdeveniment;suppress_until - (integer) temps abans que s'esborri l'esdeveniment de manteniment. |
| selectTags | query | Retorna una propietat tags amb etiquetes d'esdeveniment. |
| filter | object | Retorna nom¨¦s els resultats que coincideixen exactament amb el filtre donat. Admet un objecte, on les claus s¨®n el nom de la propietat, i els valors s¨®n b¨¦ un valor simple o una taula de valors amb la que comparar. No admet les propietats de tipus d'informaci¨® text. |
| sortfield | string/array | Ordena el resultat per les propietats donades. Valors possibles: eventid, objectid i clock.Els valors possibles quan s'empren alhora amb groupBy: objectid.Valors possibles quan s'empren alhora amb countOutput i groupBy: objectid, rowscount. |
| groupBy | string/array | Agrupa els resultats amb les propietats donades. Les propietats especificades retornaran als resultats. Valors possibles: objectid. |
| countOutput | boolean | Aquests par¨¤metres es descriuen a comentaris de refer¨¨ncia. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| select_acknowledges (obsolet) |
query | Aquest par¨¤metre ¨¦s obsolet; si us plau, empreu selectAcknowledges enlloc d'aquest.Retorna una propietat acknowledges de les actualitzacions d'esdeveniments. Les actualitzacions d'esdeveniments s'ordenen en ordre cronol¨°gic invers.L'objecte d'actualitzaci¨® d'esdeveniments t¨¦ les propietats seg¨¹ents: acknowledgeid - (string) ID del reconeixement;identificador d'usuari - (string) ID de l'usuari que va actualitzar l'esdeveniment ;eventid - (string) ID del dia actualitzat de l'esdeveniment;clock - (timestamp) hora d'actualitzaci¨® de l'esdeveniment;missatge - (string) text del missatge;²¹³¦³¦¾±¨® - (integer) ²¹³¦³¦¾±¨® d'actualitzaci¨® realitzada, vegeu event.acknowledge;< br>old_severity - (integer) gravetat de l'esdeveniment abans d'aquesta ²¹³¦³¦¾±¨® d'actualitzaci¨®;new_severity - (integer) gravetat de l'esdeveniment despr¨¦s d'aquesta ²¹³¦³¦¾±¨® d'actualitzaci¨®;username - (string) nom d'usuari de l'usuari que ha actualitzat l'esdeveniment ;nom - (string) nom de l'usuari qui ha actualitzat l'esdeveniment ;cognom - (string) cognom de l'usuari qui ha actualitzat l'esdeveniment.Admet count. |
| select_alerts (obsolet) |
query | Aquest par¨¤metre ¨¦s obsolet; si us plau, empreu selectAlerts enlloc d'aquest.Retorna una propietat alerts amb alertes generades per l'esdeveniment.Les alertes s'ordenen en ordre cronol¨°gic invers. |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el par¨¤metre
countOutputper¨° no s'ha emprat el par¨¤metregroupBy; - una matriu d'objectes amb resultats d'agregaci¨®, si s'ha emprat el par¨¤metre
groupBy.
Exemples
Recuperar esdeveniments de triggers
Recuperar els darrers esdeveniments del trigger "22395."
{
"jsonrpc": "2.0",
"method": "event.get",
"params": {
"output": "extend",
"selectAcknowledges": "extend",
"selectSuppressionData": "extend",
"selectTags": "extend",
"objectids": "22395",
"sortfield": ["clock", "eventid"],
"sortorder": "DESC"
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"eventid": "20",
"source": "0",
"object": "0",
"objectid": "22395",
"clock": "1728658089",
"value": "0",
"acknowledged": "0",
"ns": "461809482",
"name": "Load average is too high (per CPU load over 1.5 for 5m)",
"severity": "0",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"acknowledges": [],
"opdata": "Load averages(1m 5m 15m): (1.6328 3.0522 2.2515), # of CPUs: 2",
"suppression_data": [],
"suppressed": "0",
"tags": [
{
"tag": "scope",
"value": "capacity"
},
{
"tag": "scope",
"value": "performance"
},
{
"tag": "component",
"value": "cpu"
},
{
"tag": "class",
"value": "os"
},
{
"tag": "target",
"value": "linux"
}
],
"urls": []
},
{
"eventid": "4",
"source": "0",
"object": "0",
"objectid": "22395",
"clock": "1728657737",
"value": "1",
"acknowledged": "1",
"ns": "460759366",
"name": "Load average is too high (per CPU load over 1.5 for 5m)",
"severity": "3",
"r_eventid": "20",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"acknowledges": [
{
"acknowledgeid": "1",
"userid": "1",
"clock": "1728657938",
"message": "Testing environment. Please disregard this alert.",
"action": "38",
"old_severity": "0",
"new_severity": "0",
"suppress_until": "1728744338",
"taskid": "0",
"username": "Admin",
"name": "Áú»¢¶Ä²©",
"surname": "Administrator"
}
],
"opdata": "Load averages(1m 5m 15m): (1.6328 3.0522 2.2515), # of CPUs: 2",
"suppression_data": [
{
"maintenanceid": "0",
"suppress_until": "1728744338",
"userid": "1"
}
],
"suppressed": "1",
"tags": [
{
"tag": "scope",
"value": "capacity"
},
{
"tag": "scope",
"value": "performance"
},
{
"tag": "component",
"value": "cpu"
},
{
"tag": "class",
"value": "os"
},
{
"tag": "target",
"value": "linux"
}
],
"urls": []
}
],
"id": 1
}Recuperar esdeveniments per un per¨ªode de temps definit
Recuperar tots els esdeveniments que s'han creat entre el 9 i 10 d'Octubre de 2012, en ordre cronol¨°gic invers.
{
"jsonrpc": "2.0",
"method": "event.get",
"params": {
"output": "extend",
"time_from": "1349797228",
"time_till": "1350661228",
"sortfield": ["clock", "eventid"],
"sortorder": "DESC"
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"eventid": "20616",
"source": "0",
"object": "0",
"objectid": "14282",
"clock": "1350477814",
"value": "1",
"acknowledged": "0",
"ns": "0",
"name": "Less than 25% free in the history cache",
"severity": "3",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"opdata": "",
"suppressed": "0",
"urls": []
},
{
"eventid": "20617",
"source": "0",
"object": "0",
"objectid": "14283",
"clock": "1350477814",
"value": "0",
"acknowledged": "0",
"ns": "0",
"name": "Áú»¢¶Ä²© trapper processes more than 75% busy",
"severity": "3",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"opdata": "",
"suppressed": "0",
"urls": []
},
{
"eventid": "20618",
"source": "0",
"object": "0",
"objectid": "14284",
"clock": "1350477815",
"value": "1",
"acknowledged": "0",
"ns": "0",
"name": "High ICMP ping loss",
"severity": "3",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"opdata": "",
"suppressed": "0",
"urls": []
}
],
"id": 1
}Recuperant els esdeveniments reconeguts per l'usuari especificat
Recuperant els esdeveniments reconeguts per l'usuari amb ID=10
{
"jsonrpc": "2.0",
"method": "event.get",
"params": {
"output": "extend",
"action": 2,
"action_userids": [10],
"selectAcknowledges": ["userid", "action"],
"sortfield": ["eventid"],
"sortorder": "DESC"
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"eventid": "1248566",
"source": "0",
"object": "0",
"objectid": "15142",
"clock": "1472457242",
"ns": "209442442",
"r_eventid": "1245468",
"r_clock": "1472457285",
"r_ns": "125644870",
"correlationid": "0",
"userid": "10",
"name": "Áú»¢¶Ä²© agent on localhost is unreachable for 5 minutes",
"acknowledged": "1",
"severity": "3",
"cause_eventid": "0",
"acknowledges": [
{
"userid": "10",
"action": "2"
}
],
"opdata": "",
"suppressed": "0",
"urls": []
}
],
"id": 1
}Recuperant els triggers principals amb el recompte d'esdeveniments problem¨¤tics
Recupereu els 5 triggers principals que tenen la gravetat "Av¨ªs", "Mitjana", "Alta" o "Desastre", juntament amb el nombre d'esdeveniments problem¨¤tics en un per¨ªode de temps determinat.
{
"jsonrpc": "2.0",
"method": "event.get",
"params": {
"countOutput": true,
"groupBy": "objectid",
"source": 0,
"object": 0,
"value": 1,
"time_from": 1672531200,
"time_till": 1677628800,
"trigger_severities": [2, 3, 4, 5],
"sortfield": ["rowscount"],
"sortorder": "DESC",
"limit": 5
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"objectid": "232124",
"rowscount": "27"
},
{
"objectid": "29055",
"rowscount": "23"
},
{
"objectid": "253731",
"rowscount": "18"
},
{
"objectid": "254062",
"rowscount": "11"
},
{
"objectid": "23216",
"rowscount": "7"
}
],
"id": 1
}Veieu tamb¨¦
Font
CEvent::get() in ui/include/classes/api/services/CEvent.php.