graph.get

Descripció

integer/array graph.get(object parameters)

El mètode permet recuperar gràfics segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paramètres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
graphids ID/array Retorna només gràfics amb els identificadors donats.
groupids ID/array Retorna només gràfics que pertanyen als equips dels grups d'equips donats.
templateids ID/array Retorna només gràfics que pertanyen a les plantilles donades.
hostids ID/array Retorna només gràfics que pertanyen als equips donats.
itemids ID/array Retorna només gràfics que contenen els elements donats.
templated boolean Si s'estableix com a true, retorna només gràfics amb plantilla.
inherited boolean Si és true, retorna només els gràfics heretats d'un model.
expandName flag Amplieu les macros al nom del gràfic.
selectHostGroups query Retorna la propietat hostgroups amb els grups d'equip als quals pertany el gràfic.
selectTemplateGroups query Retorna la propietat templategroups amb els grups de plantilles als quals pertany el gràfic.
selectTemplates query Retorna la propietat templates amb les plantilles a les quals pertany el gràfic.
selectHosts query Retorna la propietat hosts amb els equips als quals pertany el gràfic.
selectItems query Retorna la propietat items amb els elements emprats al gràfic.
selectGraphDiscovery query Retorna la propietat graphDiscovery que conté l'objecte de descobriment de gràfics. Els objectes de descobriment de gràfics enllacen el gràfic amb un prototip de gràfic a partir del que es va crear.

Té les propietats següents:
graphid - (ID) ID de gràfic;
parent_graphid - (ID) ID del prototip de gràfic a partir del qual es va crear el gràfic;
lastcheck - (timestamp) hora en que el gràfic es va trobar per darrer cop;
status - (int) estat de la descoberta del gràfic:
0 - (per defecte) el gràfic s'ha trobat,
1 - el gràfic ja no es troba;
ts_delete - (timestamp) hora en que el gràfic que no s'ha trobat s'esborrarà.
selectGraphItems query Retorna la propietat gitems amb els elements emprats al gràfic.
selectDiscoveryRule query Retorna la propietat discoveryRule amb la regla de descoberta de baix nivell que va crear el gràfic.
filter object Només retorna resultats que coincideixen exactament amb el filtre donat.

Admet una matriu on les claus són noms de propietat i els valors són un valor únic o una matriu de valors per comparar.

No admet propietats de tipus text.

Admet filtres addicionals:
host - nom tècnic de l'equip al qual pertany el gràfic;
hostid - ID de l'equip al qual pertany el gràfic.
sortfield string/array Ordena el resultat per les propietats donades.

Els valors possibles són: graphid, name i graphtype.
countOutput boolean Aquests paràmetres, comuns a tots els mètodes get, es descriuen a comentaris de referència.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(obsolet)
query Aquest paràmetre és obsolets; si et plau, empra selectHostGroups o selectTemplateGroups.
Retorna una propietat groups amb el grup d'equips i grups de plantilles a qui pertany el gràfic.

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar gràfics dels equips

Recuperar tots els gràfics de l'equip "10107" i ordenar-los per nom.

Petició:

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

Resposta:

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

Veieu també

Font

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