graphprototype.get

Beschrijving

integer/array graphprototype.get(objectparameters)

De methode maakt het mogelijk om grafiekprototypes 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
discoveryids	string/array	Retourneer alleen grafiekprototypes die behoren tot de gegeven discovery-regels.
graphids	string/array	Retourneer alleen grafiekprototypes met de opgegeven ID's.
groupids	string/array	Retourneer alleen grafiekprototypes die behoren tot hosts in de gegeven hostgroepen.
hostids	string/array	Retourneer alleen grafiekprototypes die bij de opgegeven hosts horen.
inherited	boolean	Indien ingesteld op `true`, worden alleen grafiekprototypes geretourneerd die zijn overgenomen van een sjabloon.
itemids	string/array	Retourneer alleen grafiekprototypes die de opgegeven itemprototypes bevatten.
template	boolean	Indien ingesteld op `true`, worden alleen grafiekprototypes geretourneerd die bij sjablonen horen.
templateids	string/array	Retourneer alleen grafiekprototypes die bij de opgegeven sjablonen horen.
selectDiscoveryRule	query	Retourneer een eigenschap discoveryRule met de LLD-regel waartoe het grafiekprototype behoort.
selectGraphItems	query	Retourneer een gitems eigenschap met de grafiekitems die in het grafiekprototype worden gebruikt.
selectGroups	query	Retourneer een eigenschap groups met de hostgroepen waartoe het grafiekprototype behoort.
selectHosts	query	Retourneer een eigenschap hosts met de hosts waartoe het grafiekprototype behoort.
selectItems	query	Retourneer een eigenschap `items` met de items en item prototypes gebruikt in het prototype van de grafiek .
selectTemplates	query	Retourneer een eigenschap templates met de sjablonen waartoe het grafiekprototype behoort.
filter	object	Retourneert alleen de 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 het grafiekprototype behoort; `hostid` - ID van de host waartoe het grafiekprototype 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 in de referentiecommentaar.
editable	booleaans
excludeSearch	boolean
limiet	geheel getal
uitvoer	query
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 countOutput parameter heeft gebruikt.

Voorbeelden

Grafiekprototypes ophalen uit een LLD-regel

Haal alle grafiekprototypes op uit een LLD-regel.

Verzoek:

{
           "jsonrpc": "2.0",
           "method": "graphprototype.get",
           "params": {
               "output": "extend",
               "discoveryids": "27426"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Antwoord:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "graphid": "1017",
                   "parent_itemid": "27426",
                   "name": "Disk space usage {#FSNAME}",
                   "width": "600",
                   "height": "340",
                   "yaxismin": "0.0000",
                   "yaxismax": "0.0000",
                   "templateid": "442",
                   "show_work_period": "0",
                   "show_triggers": "0",
                   "graphtype": "2",
                   "show_legend": "1",
                   "show_3d": "1",
                   "percent_left": "0.0000",
                   "percent_right": "0.0000",
                   "ymin_type": "0",
                   "ymax_type": "0",
                   "ymin_itemid": "0",
                   "ymax_itemid": "0",
                   "discover": "0"
               }
           ],
           "id": 1
       }

Zie ook

Bron

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

Documentation