graphprototype.get

Beschrijving

integer/array graphprototype.get(object parameters)

Deze methode maakt het mogelijk om grafiek-prototypen op te halen op basis van de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. De toestemming om de methode te gebruiken kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter	Type	Beschrijving
discoveryids	string/array	Alleen grafiek-prototypen ophalen die behoren tot de opgegeven ontdekkingsregels.
graphids	string/array	Alleen grafiek-prototypen ophalen met de opgegeven IDs.
groupids	string/array	Alleen grafiek-prototypen ophalen die behoren tot hosts of templates in de opgegeven hostgroepen of templategroepen.
hostids	string/array	Alleen grafiek-prototypen ophalen die behoren tot de opgegeven hosts.
inherited	boolean	Indien ingesteld op `true`, alleen grafiek-prototypen ophalen die zijn geërfd van een sjabloon.
itemids	string/array	Alleen grafiek-prototypen ophalen die de opgegeven item-prototypen bevatten.
templated	boolean	Indien ingesteld op `true`, alleen grafiek-prototypen ophalen die behoren tot sjablonen.
templateids	string/array	Alleen grafiek-prototypen ophalen die behoren tot de opgegeven sjablonen.
selectDiscoveryRule	query	Een eigenschap discoveryRule retourneren met de LLD-regel waartoe het grafiek-prototype behoort.
selectGraphItems	query	Een eigenschap gitems retourneren met de grafiekitems die worden gebruikt in het grafiek-prototype.
selectHostGroups	query	Een eigenschap hostgroups retourneren met de hostgroepen waartoe het grafiek-prototype behoort.
selectHosts	query	Een eigenschap hosts retourneren met de hosts waartoe het grafiek-prototype behoort.
selectItems	query	Een eigenschap `items` retourneren met de items en item-prototypen die worden gebruikt in het grafiek-prototype.
selectTemplateGroups	query	Een eigenschap templategroups retourneren met de sjabloonsgroepen waartoe het grafiek-prototype behoort.
selectTemplates	query	Een eigenschap templates retourneren met de sjablonen waartoe het grafiek-prototype behoort.
filter	object	Alleen resultaten retourneren die exact overeenkomen met de opgegeven filter. Accepteert een array, waarbij de sleutels eigendomsnamen zijn en de waarden ofwel een enkele waarde ofwel een array van waarden zijn om tegenover te stellen. Ondersteunt aanvullende filters: `host` - technische naam van de host waartoe het grafiek-prototype behoort; `hostid` - ID van de host waartoe het grafiek-prototype behoort.
sortfield	string/array	De resultaten sorteren op de opgegeven eigenschappen. Mogelijke waarden: `graphid`, `name`, `graphtype`.
countOutput	boolean	Deze parameters die gemeenschappelijk zijn voor alle `get` methoden, worden in detail beschreven in de referentie toelichting.
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 `selectHostGroups` of `selectTemplateGroups` in plaats daarvan. Retourneer een `groups` eigenschap met de hostgroepen en sjabloonsgroepen waartoe het grafiek-prototype behoort.

Retourwaarden

(integer/array) Retourneert ofwel:

een reeks objecten;
het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Grafiek-prototypen ophalen vanuit een LLD-regel

Haal alle grafiek-prototypen op vanuit een LLD-regel.

Aanvraag:

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

Reactie:

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

Bron

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

Documentation