triggerprototype.get

Apraksts

integer/array triggerprototype.get(object parameters)

Šī metode ļauj izgūt trigeru prototipus atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Tiesības izsaukt šo metodi var atsaukt lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā Lietotāja lomas.

Parametri

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

Metode atbalsta šādus parametrus.

Parameter Type Description
active flag Atgriež tikai iespējotos trigeru prototipus, kas pieder uzraudzītiem hosts.
discoveryids ID/array Atgriež tikai trigeru prototipus, kas pieder norādītajiem LLD noteikumiem.
functions string/array Atgriež tikai trigerus, kas izmanto norādītās funkcijas.

Skatiet lapu Supported functions, lai iegūtu atbalstīto funkciju sarakstu.
group string Atgriež tikai trigeru prototipus, kas pieder hosts vai veidnēm no hostu grupām vai veidņu grupām ar norādīto nosaukumu.
groupids ID/array Atgriež tikai trigeru prototipus, kas pieder hosts vai veidnēm no norādītajām hostu grupām vai veidņu grupām.
host string Atgriež tikai trigeru prototipus, kas pieder hosts ar norādīto nosaukumu.
hostids ID/array Atgriež tikai trigeru prototipus, kas pieder norādītajiem hosts.
inherited boolean Ja iestatīts uz true, atgriež tikai trigeru prototipus, kas mantoti no veidnes.
maintenance boolean Ja iestatīts uz true, atgriež tikai iespējotos trigeru prototipus, kas pieder hosts tehniskās apkopes režīmā.
min_severity integer Atgriež tikai trigeru prototipus ar smaguma pakāpi, kas ir lielāka vai vienāda ar norādīto smaguma pakāpi.
monitored flag Atgriež tikai iespējotos trigeru prototipus, kas pieder uzraudzītiem hosts un satur tikai iespējotus vienumus.
templated boolean Ja iestatīts uz true, atgriež tikai trigeru prototipus, kas pieder veidnēm.
templateids ID/array Atgriež tikai trigeru prototipus, kas pieder norādītajām veidnēm.
triggerids ID/array Atgriež tikai trigeru prototipus ar norādītajiem ID.
expandExpression flag Izvērš funkcijas un makro trigeru izteiksmē.
selectDependencies query Atgriež trigeru prototipus un trigerus, no kuriem trigeru prototips ir atkarīgs, dependencies īpašībā.
selectDiscoveryRule query Atgriež LLD noteikumu, kuram pieder trigeru prototips, discoveryRule īpašībā.
selectFunctions query Atgriež funkcijas, kas izmantotas trigeru prototipā, functions īpašībā.

Funkciju objekti attēlo funkcijas, kas izmantotas trigeru izteiksmē, un tiem ir šādas īpašības:
functionid - (ID) funkcijas ID;
itemid - (ID) vienuma ID, kas izmantots funkcijā;
function - (string) funkcijas nosaukums;
parameter - (string) funkcijai nodotais parametrs. Vaicājuma parametrs atgrieztajā virknē tiek aizstāts ar $ simbolu.
selectHostGroups query Atgriež hostu grupas, kurām pieder trigeru prototips, hostgroups īpašībā.
selectHosts query Atgriež hosts, kuriem pieder trigeru prototips, hosts īpašībā.
selectItems query Atgriež vienumus un vienumu prototipus, ko izmanto trigeru prototips, items īpašībā.
selectTags query Atgriež trigeru prototipa tagus tags īpašībā.
selectTemplateGroups query Atgriež veidņu grupas, kurām pieder trigeru prototips, templategroups īpašībā.
filter object Atgriež 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 tehniskais nosaukums, kuram pieder trigeru prototips;
hostid - hosta ID, kuram pieder trigeru prototips.
limitSelects integer Ierobežo ierakstu skaitu, ko atgriež apakšatlases.

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

Iespējamās vērtības: triggerid, description, status, priority, discovered.
countOutput boolean Šie parametri ir aprakstīti reference commentary.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Šis parametrs ir novecojis, lūdzu, tā vietā izmantojiet selectHostGroups vai selectTemplateGroups.
Atgriež hostu grupas un veidņu grupas, kurām pieder trigeru prototips, groups īpašībā.

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

Iegūt trigeru prototipus no LLD noteikuma

Iegūst visus trigeru prototipus un to funkcijas no LLD noteikuma.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "triggerprototype.get",
    "params": {
        "output": "extend",
        "selectFunctions": "extend",
        "discoveryids": "22450"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "13272",
            "expression": "{12598}<20",
            "description": "Free inodes is less than 20% on volume {#FSNAME}",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "",
            "error": "",
            "templateid": "0",
            "type": "0",
            "state": "0",
            "flags": "2",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "discover": "0",
            "event_name": "",
            "uuid": "6ce467d05e8745409a177799bed34bb3",
            "url_name": "",
            "functions": [
                {
                    "functionid": "12598",
                    "itemid": "22454",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        },
        {
            "triggerid": "13266",
            "expression": "{13500}<20",
            "description": "Free disk space is less than 20% on volume {#FSNAME}",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "",
            "error": "",
            "templateid": "0",
            "type": "0",
            "state": "0",
            "flags": "2",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "discover": "0",
            "event_name": "",
            "uuid": "74a1fc62bfe24b7eabe4e244c70dc384",
            "url_name": "",
            "functions": [
                {
                    "functionid": "13500",
                    "itemid": "22686",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Konkrēta trigera prototipa izgūšana ar tagiem

Pieprasījums:

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

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17373",
            "description": "Brīvā diska vieta ir mazāka par 20% sējumā {#FSNAME}",
            "tags": [
                {
                    "tag": "volume",
                    "value": "{#FSNAME}"
                },
                {
                    "tag": "type",
                    "value": "{#FSTYPE}"
                }
            ]
        }
    ],
    "id": 1
}

Skatīt arī

Avots

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