graphprototype.get

Descripció

integer/array graphprototype.get(object parameters)

El mètode permet recuperar prototipus de 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.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre	Tipus	Descripció
discoveryids	ID/array	Retorna només prototips de gràfics que pertanyen a les regles de descobriment donades.
graphids	ID/array	Retorna només prototips de gràfics amb identificadors donats.
groupids	ID/array	Retorna només prototips de gràfics que pertanyen als equips dels grups d'equips donats.
hostids	ID/array	Retorna només prototips de gràfics que pertanyen als equips donats.
inherited	boolean	Si es defineix com a `true`, només retorna els prototips de gràfics heretats d'un model.
itemids	string/array	Retorna només prototips de gràfics que contenen els prototips d'elements donats.
templated	boolean	Si s'estableix en `true`, només retorna prototips de gràfics que pertanyen a plantilles.
templateids	ID/array	Retorna només prototips de gràfics que pertanyen a les plantilles donades.
selectDiscoveryRule	query	Retorna una propietat discoveryRule amb la regla LLD a la qual pertany el prototip de gràfic.
selectGraphItems	query	Retorna una propietat gitems amb els elements de gràfic emprats al prototip de gràfic.
selectGroups	query	Retorna una propietat groups amb els grups d'equips als quals pertany el prototip de gràfic.
selectHosts	query	Retorna una propietat hosts amb els equips als quals pertany el prototip de gràfic.
selectItems	query	Retorna una propietat `items` amb els elements i prototipus d'elements emprats al gràfic del prototip .
selectTemplateGroups	query	Retorna una propietat templategroups amb els grups de plantilles a les quals pertany el prototip de gràfic.
selectTemplates	query	Retorna una propietat plantilles amb les plantilles a les quals pertany el prototip de gràfic.
filter	object	Retorna només 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. Admet filtres addicionals: `host` - nom tècnic de l'equip al qual pertany el prototip de gràfic; `hostid` - ID de l'equip al qual pertany el prototip de gràfic.
sortfield	string/array	Ordena el resultat segons les propietats donades. Els valors possibles són: `graphid`, `name` i `graphtype`.
countOutput	boolean	Com que aquests paràmetres són comuns a tots els mètodes `get`, es descriuen en detall a comentaris de referència.
editable	boolean
excludeSearch	boolean
limit	entier
output	requête
preservekeys	boolean
search	objet
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean
selectGroups (obsolet)	query	Aquest paràmetre és obsolet; empreu en el seu lloc `selectHostGroups` o `selectTemplateGroups`. Retorna la propietat `grups` amb els grups d'equips i grups de plantilles on el gràfic pertany.

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 prototips de gràfics d'una regla LLD

Recuperar tots els prototips de gràfics d'una regla de descoberta.

Petició:

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

Resposta:

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

Veieu també

Font

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

Documentation