Table of Contents
grafiek.get
Beschrijving
integer/array graph.get(object parameters)
De methode maakt het mogelijk om grafieken op te halen volgens de gegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Beschrijving |
|---|---|---|
| graphids | string/array | Retourneer alleen grafieken met de opgegeven ID's. |
| groupids | string/array | Retourneer alleen grafieken die behoren tot hosts in de gegeven hostgroepen. |
| templateids | string/array | Retourneer alleen de grafiek die bij de opgegeven sjablonen hoort. |
| hostids | string/array | Retourneer alleen grafieken die bij de opgegeven hosts horen. |
| itemids | string/array | Retourneer alleen grafieken die de opgegeven items bevatten. |
| template | boolean | Indien ingesteld op true, worden alleen grafieken geretourneerd die bij sjablonen horen. |
| inherited | boolean | Indien ingesteld op true worden alleen grafieken geretourneerd die zijn overgenomen van een sjabloon. |
| expandName | flag | Macro's uitvouwen in de grafieknaam. |
| selectGroups | query | Retourneer een eigenschap groups met de hostgroepen waartoe de grafiek behoort. |
| selectTemplates | query | Retourneer een eigenschap templates met de templates waartoe de grafiek behoort. |
| selectHosts | query | Retourneer een eigenschap hosts met de hosts waartoe de grafiek behoort. |
| selectItems | query | Retourneer een eigenschap items met de items die in de grafiek worden gebruikt. |
| selectGraphDiscovery | query | Retourneer een eigenschap graphDiscovery met het graph discovery-object. De graph discovery-objecten koppelen de grafiek aan een grafiekprototype waaruit deze is gemaakt.Het heeft de volgende eigenschappen: graphid - (string) ID van de grafiek;parent_graphid - (string) ID van het grafiekprototype waaruit de grafiek is gemaakt. |
| selectGraphItems | query | Retourneer een gitems eigenschap met de items die in de grafiek worden gebruikt. |
| selectDiscoveryRule | query | Retourneer een eigenschap discoveryRule met de detectieregel op laag niveau die de grafiek heeft gemaakt. |
| filter | object | Retourneert alleen die resultaten die exact overeenkomen met het opgegeven filter. Accepteert een array, waarbij de sleutels eigenschapsnamen zijn en de waarden een enkele waarde zijn of een array van waarden om mee te vergelijken. Ondersteunt extra filters: host - technische naam van de host waartoe de grafiek behoort;hostid - ID van de host waartoe de grafiek behoort. |
| sortfield | string/array | Sorteer het resultaat op de gegeven eigenschappen. Mogelijke waarden zijn: graphid, name en graphtype. |
| countOutput | boolean | Deze parameters gelden voor alle get-methoden en worden in detail beschreven op de pagina referentiecommentaar. |
| editable | booleaans | |
| excludeSearch | boolean | |
| limiet | geheel getal | |
| uitvoer | vraag | |
| preservekeys | boolean | |
| zoeken | object | |
| searchByAny | boolean | |
| searchWildcardsIngeschakeld | boolean | |
| sortorde | string/array | |
| startZoeken | booleaans |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Grafieken ophalen van hosts
Haal alle grafieken op van host "10107" en sorteer ze op naam.
Verzoek:
{
"jsonrpc": "2.0",
"method": "graph.get",
"params": {
"output": "extend",
"hostids": 10107,
"sortfield": "name"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"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
}Zie ook
Bron
CGraph::get() in ui/include/classes/api/services/CGraph.php.