Documentation
Table of Contents
event.get
Descripció
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.
Paràmetres
(object) Paràmetres que defineixen la sortida esperada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| 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. |
| 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) acció d'actualització que s'ha executat; veieu event.acknowledge;old_severity - (integer) gravetat de l'esdeveniment abans d'aquesta acció d'actualització;new_severity - (integer) gravetat de l'esdeveniment després d'aquesta acció 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, comuns a tots els mètodes get, 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;acció - (integer) acció d'actualització realitzada, vegeu event.acknowledge;< br>old_severity - (integer) gravetat de l'esdeveniment abans d'aquesta acció d'actualització;new_severity - (integer) gravetat de l'esdeveniment després d'aquesta acció 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 "13926."
{
"jsonrpc": "2.0",
"method": "event.get",
"params": {
"output": "extend",
"selectAcknowledges": "extend",
"selectSuppressionData": "extend",
"selectTags": "extend",
"objectids": "13926",
"sortfield": ["clock", "eventid"],
"sortorder": "DESC"
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"eventid": "9695",
"source": "0",
"object": "0",
"objectid": "13926",
"clock": "1347970410",
"value": "1",
"acknowledged": "1",
"ns": "413316245",
"name": "MySQL is down",
"severity": "5",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"acknowledges": [
{
"acknowledgeid": "1",
"userid": "1",
"clock": "1350640590",
"message": "Problem resolved.\n\r----[BULK ACKNOWLEDGE]----",
"action": "6",
"old_severity": "0",
"new_severity": "0",
"suppress_until": "1472511600",
"taskid": "0",
"username": "Admin",
"name": "Zabbix",
"surname": "Administrator"
}
],
"opdata": "",
"suppression_data": [
{
"maintenanceid": "15",
"suppress_until": "1472511600",
"userid": "0"
}
],
"suppressed": "1",
"tags": [
{
"tag": "service",
"value": "mysqld"
},
{
"tag": "error",
"value": ""
}
],
"urls": []
},
{
"eventid": "9671",
"source": "0",
"object": "0",
"objectid": "13926",
"clock": "1347970347",
"value": "0",
"acknowledged": "0",
"ns": "0",
"name": "Unavailable by ICMP ping",
"severity": "4",
"r_eventid": "0",
"c_eventid": "0",
"correlationid": "0",
"userid": "0",
"cause_eventid": "0",
"acknowledges": [],
"opdata": "",
"suppression_data": [],
"suppressed": "0",
"tags": [],
"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": "Zabbix 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": "Zabbix 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.