Documentation
Table of Contents
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 | string/array | Retorna només gràfics amb els identificadors donats. |
| groupids | string/array | Retorna només gràfics que pertanyen als equips dels grups d'equips donats. |
| templateids | string/array | Retorna només gràfics que pertanyen a les plantilles donades. |
| hostids | string/array | Retorna només gràfics que pertanyen als equips donats. |
| itemids | string/array | Retorna només gràfics que contenen els elements donats. |
| template | boolean | Si s'estableix com a true, retorna només gràfics amb plantilla. |
| inherited | booleà | Si és cert, retorna només els gràfics heretats d'un model. |
| expandName | flag | Amplieu les macros al nom del gràfic. |
| selectGroups | query | Retorna la propietat grups amb els grups d'equip als quals pertany el gràfic. |
| selectTemplates | query | Retorna la propietat plantilles amb les plantilles a les quals pertany el gràfic. |
| selectHosts | query | Retorna la propietat equips amb els equips als quals pertany el gràfic. |
| selectItems | query | Retorna la propietat elements 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 - (cadena) ID de gràfic; parent_graphid - (cadena) ID del prototip de gràfic a partir del qual es va crear el gràfic. |
| 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. Accepta 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.< br> 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 |
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"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"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.