graph.get

Apraksts

integer/array graph.get(object parameters)

Šī metode ļauj izgūt grafikus 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.

Parameter Type Description
graphids ID/array Atgriezt tikai grafikus ar norādītajiem ID.
groupids ID/array Atgriezt tikai grafikus, kas pieder hosts vai veidnēm norādītajās hostu grupās vai veidņu grupās.
templateids ID/array Atgriezt tikai grafikus, kas pieder norādītajām veidnēm.
hostids ID/array Atgriezt tikai grafikus, kas pieder norādītajiem hosts.
itemids ID/array Atgriezt tikai grafikus, kas satur norādītos vienumus.
templated boolean Ja iestatīts uz true, atgriezt tikai grafikus, kas pieder veidnēm.
inherited boolean Ja iestatīts uz true, atgriezt tikai grafikus, kas mantoti no veidnes.
expandName flag Izvērst makro grafika nosaukumā.
selectHostGroups query Atgriezt hostgroups īpašību ar hostu grupām, kurām pieder grafiks.
selectTemplateGroups query Atgriezt templategroups īpašību ar veidņu grupām, kurām pieder grafiks.
selectTemplates query Atgriezt templates īpašību ar veidnēm, kurām pieder grafiks.
selectHosts query Atgriezt hosts īpašību ar hosts, kuriem pieder grafiks.
selectItems query Atgriezt items īpašību ar vienumiem, kas tiek izmantoti grafikā.
selectGraphDiscovery query Atgriezt graphDiscovery īpašību ar grafika atklāšanas objektu. Grafika atklāšanas objekts saista grafiku ar grafika prototipu, no kura tas tika izveidots.

Tam ir šādas īpašības:
graphid - (ID) grafika ID;
parent_graphid - (ID) grafika prototipa ID, no kura grafiks tika izveidots;
lastcheck - (timestamp) laiks, kad grafiks pēdējo reizi tika atklāts;
status - (int) grafika atklāšanas statuss:
0 - (noklusējums) grafiks ir atklāts,
1 - grafiks vairs nav atklāts;
ts_delete - (timestamp) laiks, kad grafiks, kas vairs nav atklāts, tiks dzēsts.
selectGraphItems query Atgriezt gitems īpašību ar vienumiem, kas tiek izmantoti grafikā.
selectDiscoveryRule query Atgriezt discoveryRule īpašību ar zemā līmeņa atklāšanas noteikumu, kas izveidoja grafiku.
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.

Nepieciešams neatbalsta text datu tipu.

Atbalsta papildu īpašības:
host - tehniskais hosts nosaukums, kuram pieder grafiks;
hostid - hosts ID, kuram pieder grafiks.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: graphid, name, graphtype.
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
selectGroups
(deprecated)		 query Šis parametrs ir novecojis, lūdzu, tā vietā izmantojiet selectHostGroups vai selectTemplateGroups.
Atgriezt groups īpašību ar hostu grupām un veidņu grupām, kurām pieder grafiks.

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

Grafiku izgūšana no hostiem

Izgūstiet visus grafikus no hosta "10107" un sakārtojiet tos pēc nosaukuma.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "graph.get",
    "params": {
        "output": "extend",
        "hostids": 10107,
        "sortfield": "name"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "612",
            "name": "CPU jumps",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "439",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "613",
            "name": "CPU load",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "433",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "614",
            "name": "CPU utilization",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "387",
            "show_work_period": "1",
            "show_triggers": "0",
            "graphtype": "1",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "1",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "645",
            "name": "Disk space usage /",
            "width": "600",
            "height": "340",
            "yaxismin": "0",
            "yaxismax": "0",
            "templateid": "0",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "4"
        }
    ],
    "id": 1
}

Skatiet arī

Avots

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