event.get

Apraksts

integer/array event.get(object parameters)

Metode ļauj izgūt notikumus atbilstoši norādītajiem parametriem.

Šī metode var atgriezt dzēstas entītijas notikumus, ja šie notikumi vēl nav noņemti ar housekeeper.

Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet Lietotāju lomas.

Parametri

(object) Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
eventids ID/array Atgriezt tikai notikumus ar norādītajiem ID.
groupids ID/array Atgriezt tikai notikumus, ko izveidojuši objekti, kas pieder norādītajām hostu grupām.
hostids ID/array Atgriezt tikai notikumus, ko izveidojuši objekti, kas pieder norādītajiem hostiem.
objectids ID/array Atgriezt tikai notikumus, ko izveidojuši norādītie objekti.
source integer Atgriezt tikai notikumus ar norādīto tipu.

Atbalstīto notikumu tipu sarakstu skatiet notikuma objekta lapā.

Noklusējums: 0 - trigeru notikumi.
object integer Atgriezt tikai notikumus, ko izveidojuši norādītā tipa objekti.

Atbalstīto objektu tipu sarakstu skatiet notikuma objekta lapā.

Noklusējums: 0 - trigeris.
acknowledged boolean Ja iestatīts uz true, atgriezt tikai apstiprinātos notikumus.
action integer Atgriezt tikai notikumus, kuriem ir veiktas norādītās notikumu atjaunināšanas darbības. Vairāku darbību gadījumā izmantojiet jebkuru pieļaujamo bitkartes vērtību summu kā bitmasku (piemēram, 34 notikuma apstiprināšanai un apspiešanai).
action_userids ID/array Atgriezt tikai notikumus ar norādītajiem to lietotāju ID, kuri veica notikumu atjaunināšanas darbības.
suppressed boolean Ja iestatīts uz true, atgriezt tikai apspiestos notikumus.
symptom boolean Ja iestatīts uz true, atgriezt tikai simptomu notikumus.
severities integer/array Atgriezt tikai notikumus ar norādītajām notikumu nopietnības pakāpēm. Attiecas tikai tad, ja objekts ir trigeris.
trigger_severities integer/array Atgriezt tikai notikumus ar norādītajām trigeru nopietnības pakāpēm. Attiecas tikai tad, ja objekts ir trigeris.
evaltype integer Birku novērtēšanas metode.

Iespējamās vērtības:
0 - (noklusējums) Un/Vai;
2 - Vai.
tags array Atgriezt tikai notikumus ar norādītajām birkām.
Formāts: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus notikumus.

Iespējamās operator vērtības:
0 - (noklusējums) Satur;
1 - Vienāds ar;
2 - Nesatur;
3 - Nav vienāds ar;
4 - Eksistē;
5 - Neeksistē.
eventid_from string Atgriezt tikai notikumus ar ID, kas ir lielāki vai vienādi ar norādīto ID.
eventid_till string Atgriezt tikai notikumus ar ID, kas ir mazāki vai vienādi ar norādīto ID.
time_from timestamp Atgriezt tikai notikumus, kas izveidoti norādītajā laikā vai vēlāk.
time_till timestamp Atgriezt tikai notikumus, kas izveidoti norādītajā laikā vai agrāk.
problem_time_from timestamp Atgriež tikai notikumus, kas bija problēmas stāvoklī no problem_time_from neatkarīgi no to pašreizējā statusa. Attiecas tikai tad, ja avots ir trigera notikums un objekts ir trigeris. Šis parametrs ir obligāts, ja ir norādīts problem_time_till.
problem_time_till timestamp Atgriež tikai notikumus, kas bija problēmas stāvoklī līdz problem_time_till neatkarīgi no to pašreizējā statusa. Attiecas tikai tad, ja avots ir trigera notikums un objekts ir trigeris. Šis parametrs ir obligāts, ja ir norādīts problem_time_from.
value integer/array Atgriezt tikai notikumus ar norādītajām vērtībām.
selectAcknowledges query Atgriezt acknowledges īpašību ar notikumu atjauninājumiem. Notikumu atjauninājumi tiek kārtoti apgrieztā hronoloģiskā secībā.

Notikuma atjauninājuma objektam ir šādas īpašības:
acknowledgeid - (ID) apstiprinājuma ID;
userid - (ID) tā lietotāja ID, kurš atjaunināja notikumu;
clock - (timestamp) laiks, kad notikums tika atjaunināts;
message - (string) ziņojuma teksts;
action - (integer) veiktā atjaunināšanas darbība, skatiet event.acknowledge;
old_severity - (integer) notikuma nopietnības pakāpe pirms šīs atjaunināšanas darbības;
new_severity - (integer) notikuma nopietnības pakāpe pēc šīs atjaunināšanas darbības;
suppress_until - (timestamp) laiks, līdz kuram notikums būs apspiests;
taskid - (ID) uzdevuma ID, ja pašlaik notikumam tiek mainīts rangs;
username - (string) tā lietotāja lietotājvārds, kurš atjaunināja notikumu;
name - (string) tā lietotāja vārds, kurš atjaunināja notikumu;
surname - (string) tā lietotāja uzvārds, kurš atjaunināja notikumu.

Atbalsta count.
selectAlerts query Atgriezt alerts īpašību ar notikuma ģenerētajiem brīdinājumiem. Brīdinājumi tiek kārtoti apgrieztā hronoloģiskā secībā.
selectHosts query Atgriezt hosts īpašību ar hostiem, kuros atrodas objekts, kas izveidoja notikumu. Atbalstīts tikai notikumiem, ko ģenerējuši trigeri, vienumi vai LLD kārtulas.
selectRelatedObject query Atgriezt relatedObject īpašību ar objektu, kas izveidoja notikumu. Atgrieztā objekta tips ir atkarīgs no notikuma tipa.
selectSuppressionData query Atgriezt suppression_data īpašību ar aktīvo uzturēšanu un manuālo apspiešanu sarakstu:
maintenanceid - (ID) uzturēšanas ID;
userid - (ID) tā lietotāja ID, kurš apspieda notikumu;
suppress_until - (integer) laiks, līdz kuram notikums ir apspiests.
selectTags query Atgriezt tags īpašību ar notikuma birkām.
filter object Atgriezt tikai tos rezultātus, kas precīzi atbilst norādītajam filtram.

Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir vai nu viena vērtība, vai vērtību masīvs, ar ko salīdzināt.

Neatbalsta text datu tipa īpašības.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: eventid, objectid, clock.

Iespējamās vērtības, ja lieto kopā ar groupBy: objectid.

Iespējamās vērtības, ja lieto kopā ar countOutput un groupBy: objectid, rowscount.
groupBy string/array Grupēt rezultātus pēc norādītajām īpašībām. Norādītās īpašības tiks atgrieztas rezultātos.

Iespējamās vērtības: objectid.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu
  • izgūto objektu skaitu, ja ir izmantots parametrs countOutput, bet nav izmantots parametrs groupBy
  • objektu masīvu ar agregācijas rezultātiem, ja ir izmantots parametrs groupBy

Piemēri

Trigera notikumu izgūšana

Izgūstiet jaunākos notikumus no trigera "22395".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "event.get",
    "params": {
        "output": "extend",
        "selectAcknowledges": "extend",
        "selectSuppressionData": "extend",
        "selectTags": "extend",
        "objectids": "22395",
        "sortfield": ["clock", "eventid"],
        "sortorder": "DESC"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "20",
            "source": "0",
            "object": "0",
            "objectid": "22395",
            "clock": "1728658089",
            "value": "0",
            "acknowledged": "0",
            "ns": "461809482",
            "name": "Vidējā slodze ir pārāk augsta (slodze uz CPU pārsniedz 1.5 5 minūtes)",
            "severity": "0",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "acknowledges": [],
            "opdata": "Vidējās slodzes (1m 5m 15m): (1.6328 3.0522 2.2515), CPU skaits: 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": "Vidējā slodze ir pārāk augsta (slodze uz CPU pārsniedz 1.5 5 minūtes)",
            "severity": "3",
            "r_eventid": "20",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "acknowledges": [
                {
                    "acknowledgeid": "1",
                    "userid": "1",
                    "clock": "1728657938",
                    "message": "Testēšanas vide. Lūdzu, ignorējiet šo brīdinājumu.",
                    "action": "38",
                    "old_severity": "0",
                    "new_severity": "0",
                    "suppress_until": "1728744338",
                    "taskid": "0",
                    "username": "Admin",
                    "name": "Zabbix",
                    "surname": "Administrator"
                }
            ],
            "opdata": "Vidējās slodzes (1m 5m 15m): (1.6328 3.0522 2.2515), CPU skaits: 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
}

Notikumu izgūšana pēc laika perioda

Izgūstiet visus notikumus, kas ir izveidoti no 2012. gada 17. līdz 18. oktobrim, apgrieztā hronoloģiskā secībā.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "event.get",
    "params": {
        "output": "extend",
        "time_from": "1350432000",
        "time_till": "1350518400",
        "sortfield": ["clock", "eventid"],
        "sortorder": "DESC"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "20617",
            "source": "0",
            "object": "0",
            "objectid": "14282",
            "clock": "1350477816",
            "value": "1",
            "acknowledged": "0",
            "ns": "0",
            "name": "Mazāk nekā 25% brīvas vietas vēstures kešatmiņā",
            "severity": "3",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "opdata": "",
            "suppressed": "0",
            "urls": []
        },
        {
            "eventid": "20616",
            "source": "0",
            "object": "0",
            "objectid": "14281",
            "clock": "1350477814",
            "value": "0",
            "acknowledged": "0",
            "ns": "0",
            "name": "Zabbix trapper procesi ir noslogoti vairāk nekā par 75%",
            "severity": "0",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "opdata": "",
            "suppressed": "0",
            "urls": []
        },
        {
            "eventid": "20615",
            "source": "0",
            "object": "0",
            "objectid": "14281",
            "clock": "1350477541",
            "value": "1",
            "acknowledged": "0",
            "ns": "0",
            "name": "Zabbix trapper procesi ir noslogoti vairāk nekā par 75%",
            "severity": "3",
            "r_eventid": "20616",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "opdata": "",
            "suppressed": "0",
            "urls": []
        }
    ],
    "id": 1
}

Notikumu izgūšana, kurus apstiprinājis norādītais lietotājs

Notikumu izgūšana, kurus apstiprinājis lietotājs ar ID=10

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "event.get",
    "params": {
        "output": "extend",
        "action": 2,
        "action_userids": [10],
        "selectAcknowledges": ["userid", "action"],
        "sortfield": ["eventid"],
        "sortorder": "DESC"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "503",
            "source": "0",
            "object": "0",
            "objectid": "23162",
            "clock": "1747212236",
            "value": "1",
            "acknowledged": "1",
            "ns": "413470863",
            "name": "Number of installed packages has been changed",
            "severity": "2",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "cause_eventid": "0",
            "acknowledges": [
                {
                    "userid": "10",
                    "action": "2"
                }
            ],
            "opdata": "",
            "suppressed": "0",
            "urls": []
        }
    ],
    "id": 1
}

Augstāko trigeru izgūšana pēc problēmu notikumu skaita

Izgūstiet 5 augstākos trigerus ar nopietnības līmeņiem "Brīdinājums", "Vidējs", "Augsts" vai "Katastrofa", kopā ar problēmu notikumu skaitu norādītajā laika periodā.

Pieprasījums:

{
    "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
}

Atbilde:

{
    "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
}

Skatiet arī

Avots

CEvent::get() failā ui/include/classes/api/services/CEvent.php.