service.get

Apraksts

integer/array service.get(object parameters)

Metode ļauj izgūt pakalpojumus 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 Lietotāju lomas.

Parametri

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

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
serviceids ID/array Atgriezt tikai pakalpojumus ar norādītajiem ID.
parentids ID/array Atgriezt tikai pakalpojumus, kas ir saistīti ar norādītajiem vecākpakalpojumiem.
deep_parentids flag Atgriezt visus tiešos un netiešos bērnpakalpojumus. Lieto kopā ar parentids.
childids ID/array Atgriezt tikai pakalpojumus, kas ir saistīti ar norādītajiem bērnpakalpojumiem.
evaltype integer Birku novērtēšanas metode.

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

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ē.
problem_tags object/array Atgriezt tikai pakalpojumus ar norādītajām problēmu birkām.
Formāts: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus pakalpojumus.

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ē.
without_problem_tags flag Atgriezt tikai pakalpojumus bez problēmu birkām.
slaids ID/array Atgriezt tikai pakalpojumus, kas ir saistīti ar konkrēto SLA vai konkrētajiem SLA.
selectChildren query Atgriezt children īpašību ar bērnpakalpojumiem.

Atbalsta count.
selectParents query Atgriezt parents īpašību ar vecākpakalpojumiem.

Atbalsta count.
selectTags query Atgriezt tags īpašību ar pakalpojumu birkām.

Atbalsta count.
selectProblemEvents query Atgriezt problem_events īpašību ar problēmu notikumu objektu masīvu.

Problēmu notikuma objektam ir šādas īpašības:
eventid - (ID) Notikuma ID;
severity - (string) Pašreizējā notikuma nopietnība;
name - (string) Atrisinātā notikuma nosaukums.

Atbalsta count.
selectProblemTags query Atgriezt problem_tags īpašību ar problēmu birkām.

Atbalsta count.
selectStatusRules query Atgriezt status_rules īpašību ar statusa noteikumiem.

Atbalsta count.
selectStatusTimeline object/array Atgriezt status_timeline īpašību, kas satur pakalpojuma stāvokļa izmaiņas norādītajos periodos.

Formāts [{"period_from": "<period_from>", "period_to": "<period_to>"}, ...] — period_from ir perioda sākuma datums (ieskaitot; integer timestamp), bet period_to ir perioda beigu datums (neieskaitot; integer timestamp) periodam, kas jūs interesē.

Atgriež ierakstu masīvu, kas satur start_value īpašību un alarms masīvu ar stāvokļa izmaiņām norādītajos periodos.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: serviceid, name, status, sortorder, created_at.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
editable boolean
excludeSearch boolean
filter object
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;
  • iegūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Visu pakalpojumu izgūšana

Izgūstiet visus datus par visiem pakalpojumiem un to atkarībām.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "service.get",
    "params": {
        "output": "extend",
        "selectChildren": "extend",
        "selectParents": ["serviceid", "name"]
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "serviceid": "1",
            "name": "Zabbix cluster",
            "status": "-1",
            "algorithm": "2",
            "sortorder": "0",
            "weight": "0",
            "propagation_rule": "0",
            "propagation_value": "0",
            "description": "",
            "uuid": "8d77bd91b62347e4b79382912eb5df95",
            "created_at": "1761742392",
            "readonly": false,
            "parents": [],
            "children": [
                {
                    "serviceid": "2",
                    "name": "Zabbix server node 1",
                    "status": "-1",
                    "algorithm": "2",
                    "sortorder": "0",
                    "weight": "0",
                    "propagation_rule": "0",
                    "propagation_value": "0",
                    "description": "",
                    "uuid": "195911d26d7f4e218d6217079bcd5929",
                    "created_at": "1761742623",
                    "readonly": false
                },
                {
                    "serviceid": "3",
                    "name": "Zabbix server node 2",
                    "status": "-1",
                    "algorithm": "2",
                    "sortorder": "0",
                    "weight": "0",
                    "propagation_rule": "0",
                    "propagation_value": "0",
                    "description": "",
                    "uuid": "9fc659a30fe244f690dff25fc2a9db5c",
                    "created_at": "1761742654",
                    "readonly": false
                }
            ]
        },
        {
            "serviceid": "2",
            "name": "Zabbix server node 1",
            "status": "-1",
            "algorithm": "2",
            "sortorder": "0",
            "weight": "0",
            "propagation_rule": "0",
            "propagation_value": "0",
            "description": "",
            "uuid": "195911d26d7f4e218d6217079bcd5929",
            "created_at": "1761742623",
            "readonly": false,
            "parents": [
                {
                    "serviceid": "1",
                    "name": "Zabbix cluster"
                }
            ],
            "children": []
        },
        {
            "serviceid": "3",
            "name": "Zabbix server node 2",
            "status": "-1",
            "algorithm": "2",
            "sortorder": "0",
            "weight": "0",
            "propagation_rule": "0",
            "propagation_value": "0",
            "description": "",
            "uuid": "9fc659a30fe244f690dff25fc2a9db5c",
            "created_at": "1761742654",
            "readonly": false,
            "parents": [
                {
                    "serviceid": "1",
                    "name": "Zabbix cluster"
                }
            ],
            "children": []
        }
    ],
    "id": 1
}

Avots

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