trigger.get

Apraksts

integer/array trigger.get(object parameters)

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

Šī 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 sadaļā Lietotāju lomas.

Parametri

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

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
triggerids ID/array Atgriezt tikai trigerus ar norādītajiem ID.
groupids ID/array Atgriezt tikai trigerus, kas pieder hostiem vai veidnēm no norādītajām hostu grupām vai veidņu grupām.
templateids ID/array Atgriezt tikai trigerus, kas pieder norādītajām veidnēm.
hostids ID/array Atgriezt tikai trigerus, kas pieder norādītajiem hostiem.
itemids ID/array Atgriezt tikai trigerus, kas satur norādītos vienumus.
functions string/array Atgriezt tikai trigerus, kas izmanto norādītās funkcijas.

Atbalstīto funkciju sarakstu skatiet lapā supported function.
group string Atgriezt tikai trigerus, kas pieder hostiem vai veidnēm no hostu grupas vai veidņu grupas ar norādīto nosaukumu.
host string Atgriezt tikai trigerus, kas pieder hostam ar norādīto tehnisko nosaukumu.
inherited boolean Ja iestatīts uz true, atgriezt tikai no veidnes mantotos trigerus.
templated boolean Ja iestatīts uz true, atgriezt tikai trigerus, kas pieder veidnēm.
dependent boolean Ja iestatīts uz true, atgriezt tikai trigerus, kuriem ir atkarības. Ja iestatīts uz false, atgriezt tikai trigerus, kuriem nav atkarību.
monitored flag Atgriezt tikai iespējotus trigerus, kas pieder uzraudzītiem hostiem un satur tikai iespējotus vienumus.
active flag Atgriezt tikai iespējotus trigerus, kas pieder uzraudzītiem hostiem.
maintenance boolean Ja iestatīts uz true, atgriezt tikai iespējotus trigerus, kas pieder hostiem apkopes režīmā.
withUnacknowledgedEvents flag Atgriezt tikai trigerus, kuriem ir neapstiprināti notikumi.
withAcknowledgedEvents flag Atgriezt tikai trigerus, kuriem visi notikumi ir apstiprināti.
withLastEventUnacknowledged flag Atgriezt tikai trigerus, kuriem pēdējais notikums nav apstiprināts.
skipDependent flag Izlaist trigerus problēmas stāvoklī, kas ir atkarīgi no citiem trigeriem. Ņemiet vērā, ka citi trigeri tiek ignorēti, ja tie ir atspējoti, tiem ir atspējoti vienumi vai atspējotu vienumu hosti.
lastChangeSince timestamp Atgriezt tikai trigerus, kas mainījuši savu stāvokli pēc norādītā laika.
lastChangeTill timestamp Atgriezt tikai trigerus, kas mainījuši savu stāvokli pirms norādītā laika.
only_true flag Atgriezt tikai trigerus, kas nesen bijuši problēmas stāvoklī.
min_severity integer Atgriezt tikai trigerus, kuru nopietnības līmenis ir lielāks vai vienāds ar norādīto.
evaltype integer Birkas novērtēšanas metode.

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

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ē.
expandComment flag Izvērst makrosus trigera aprakstā.
expandDescription flag Izvērst makrosus trigera nosaukumā.
expandExpression flag Izvērst funkcijas un makrosus trigera izteiksmē.
selectHostGroups query Atgriezt hostu grupas, kurām trigeris pieder, īpašībā hostgroups.
selectHosts query Atgriezt hostus, kuriem trigeris pieder, īpašībā hosts.
selectItems query Atgriezt trigerī iekļautos vienumus īpašībā items.
selectFunctions query Atgriezt trigerī izmantotās funkcijas īpašībā functions.

Funkciju objekti attēlo trigera izteiksmē izmantotās funkcijas, un tiem ir šādas īpašības:
functionid - (ID) funkcijas ID;
itemid - (ID) funkcijā izmantotā vienuma ID;
function - (string) funkcijas nosaukums;
parameter - (string) funkcijai nodotais parametrs. Vaicājuma parametrs atgrieztajā virknē tiek aizstāts ar simbolu $.
selectDependencies query Atgriezt trigerus, no kuriem trigeris ir atkarīgs, īpašībā dependencies.
selectDiscoveryData query Atgriezt discoveryData īpašību ar trigera atklāšanas objekta datiem. Trigera atklāšanas objekts sasaista atklātu trigeri ar trigera prototipu, no kura tas tika atklāts.

Tam ir šādas īpašības:
parent_triggerid - (ID) trigera prototipa ID, no kura trigeris ir izveidots;
status - (int) trigera atklāšanas statuss:
0 - (noklusējums) trigeris ir atklāts,
1 - trigeris vairs nav atklāts;
ts_delete - (timestamp) laiks, kad trigeris, kas vairs netiek atklāts, tiks dzēsts;
ts_disable - (timestamp) laiks, kad trigeris, kas vairs netiek atklāts, tiks atspējots;
disable_source - (int) indikators, vai trigeri atspējoja LLD kārtula vai manuāli:
0 - (noklusējums) atspējots automātiski,
1 - atspējots ar LLD kārtulu.
selectDiscoveryRule query Atgriezt zema līmeņa atklāšanas kārtulu, kas izveidoja trigeri, īpašībā discoveryRule.
selectLastEvent query Atgriezt pēdējo nozīmīgo trigera notikumu īpašībā lastEvent.
selectTags query Atgriezt trigera birkas īpašībā tags.
inheritedTags boolean Atgriezt trigerus, kuriem norādītās tags ir arī veidnē/hostā/piesaistītajās veidnēs.

Iespējamās vērtības:
true - veidnei/hostam/piesaistītajām veidnēm arī jābūt norādītajām birkām;
false - (noklusējums) birkas no veidnes/hosta/piesaistītajām veidnēm tiek ignorētas.
selectInheritedTags query Atgriezt inheritedTags īpašību ar birkām, kas mantotas no veidnēm, piesaistītajām veidnēm un hostiem, kā arī no vienumiem, uz kuriem atsaucas trigera vai atkopšanas izteiksmes.
selectTemplateGroups query Atgriezt veidņu grupas, kurām trigeris pieder, īpašībā templategroups.
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.

Atbalsta papildu īpašības:
host - hosta, kuram trigeris pieder, tehniskais nosaukums;
hostid - hosta, kuram trigeris pieder, ID.
limitSelects integer Ierobežo apakšvaicājumu atgriezto ierakstu skaitu.

Attiecas uz šādiem apakšvaicājumiem:
selectHosts - rezultāti tiks kārtoti pēc host.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Šie parametri ir aprakstīti atsauces komentāros.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectTriggerDiscovery query Atgriezt trigera atklāšanas objektu īpašībā triggerDiscovery. Trigera atklāšanas objekti sasaista trigeri ar trigera prototipu, no kura tas tika izveidots.

Šis vaicājums ir novecojis, lūdzu, tā vietā izmantojiet selectDiscoveryData.

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.

Piemēri

Datu izgūšana pēc trigera ID

Izgūstiet visus datus un funkcijas, kas tiek izmantotas trigerī "14062".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "triggerids": "14062",
        "output": "extend",
        "selectFunctions": "extend"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "14062",
            "expression": "{13513}<10m",
            "description": "{HOST.NAME} has been restarted (uptime < 10m)",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "The host uptime is less than 10 minutes",
            "error": "",
            "templateid": "10016",
            "type": "0",
            "state": "0",
            "flags": "0",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "event_name": "",
            "uuid": "",
            "url_name": "",
            "functions": [
                {
                    "functionid": "13513",
                    "itemid": "24350",
                    "triggerid": "14062",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Trigeru izgūšana problēmas stāvoklī

Izgūstiet visu trigeru ID, nosaukumu un svarīguma līmeni, kas ir problēmas stāvoklī, un kārtojiet tos pēc svarīguma līmeņa dilstošā secībā.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description",
            "priority"
        ],
        "filter": {
            "value": 1
        },
        "sortfield": "priority",
        "sortorder": "DESC"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "13907",
            "description": "Zabbix pašuzraudzības procesi ir aizņemti mazāk nekā 100%",
            "priority": "4"
        },
        {
            "triggerid": "13824",
            "description": "Zabbix atklāšanas procesi ir aizņemti vairāk nekā 75%",
            "priority": "3"
        }
    ],
    "id": 1
}

Konkrēta trigera ar tagiem izgūšana

Izgūstiet konkrētu trigeri ar tagiem.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description"
        ],
        "selectTags": "extend",
        "triggerids": [
            "17578"
        ]
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17370",
            "description": "Service status",
            "tags": [
                {
                    "tag": "service",
                    "value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}",
                    "automatic": "1"
                },
                {
                    "tag": "error",
                    "value": "",
                    "automatic": "1"
                }
            ]
        }
    ],
    "id": 1
}

Skatiet arī

Avots

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