Documentation
Table of Contents
grafiek.get
Beschrijving
integer/array graph.get(object parameters)
Deze methode maakt het mogelijk om grafieken op te halen volgens de opgegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode op te roepen kunnen worden ingetrokken in de gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Omschrijving |
|---|---|---|
| graphids | string/array | Geef alleen grafieken terug met de opgegeven ID's. |
| groupids | string/array | Geef alleen grafieken terug die behoren tot hosts of sjablonen in de opgegeven hostgroepen of sjabloongroepen. |
| templateids | string/array | Geef alleen grafieken terug die behoren tot de opgegeven sjablonen. |
| hostids | string/array | Geef alleen grafieken terug die behoren tot de opgegeven hosts. |
| itemids | string/array | Geef alleen grafieken terug die de opgegeven items bevatten. |
| templated | boolean | Indien ingesteld op true, geef alleen grafieken terug die bij sjablonen horen. |
| inherited | boolean | Indien ingesteld op true, geef alleen grafieken terug die zijn overgenomen van een sjabloon. |
| expandName | flag | Breid macro's uit in de grafieknaam. |
| selectHostGroups | query | Geef een eigenschap hostgroups terug met de hostgroepen waartoe de grafiek behoort. |
| selectTemplateGroups | query | Geef een eigenschap templategroups terug met de sjabloongroepen waartoe de grafiek behoort. |
| selectTemplates | query | Geef een eigenschap templates terug met de sjablonen waartoe de grafiek behoort. |
| selectHosts | query | Geef een eigenschap hosts terug met de hosts waartoe de grafiek behoort. |
| selectItems | query | Geef een eigenschap items terug met de items die in de grafiek worden gebruikt. |
| selectGraphDiscovery | query | Geef een eigenschap graphDiscovery terug met het grafiekontdekkingsobject. Het grafiekontdekkingsobject linkt 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 | Geef een eigenschap gitems terug met de items die in de grafiek worden gebruikt. |
| selectDiscoveryRule | query | Geef een eigenschap discoveryRule terug met de laag-niveau ontdekkingsregel die de grafiek heeft gemaakt. |
| filter | object | Geef alleen resultaten terug die exact overeenkomen met de opgegeven filter. Accepteert een array, waarbij de sleutels eigenschapsnamen zijn en de waarden ofwel een enkele waarde zijn of een array van waarden om tegen te matchen. Ondersteunt aanvullende 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 opgegeven eigenschappen. Mogelijke waarden: graphid, name, graphtype. |
| countOutput | boolean | Deze parameters zijn gemeenschappelijk voor alle get-methoden en worden in detail beschreven op de referentiepagina. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| selectGroups (deprecated) |
query | Deze parameter is verouderd, gebruik alstublieft selectHostGroups of selectTemplateGroups in plaats daarvan.Geeft een eigenschap groups terug met de hostgroepen en sjabloongroepen waartoe de grafiek behoort. |
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.
{
"jsonrpc": "2.0",
"method": "graph.get",
"params": {
"output": "extend",
"hostids": 10107,
"sortfield": "name"
},
"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.