graphprototype.get

Descrizione

integer/array graphprototype.get(object parameters)

Questo metodo consente di recuperare i prototipi di grafico in base ai parametri specificati.

Questo metodo è disponibile per utenti di qualsiasi tipo. Le autorizzazioni per chiamare il metodo possono essere revocate nelle impostazioni del ruolo utente. Vedere User roles per ulteriori informazioni.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parameter Type Description
discoveryids ID/array Restituisce solo i graph prototype che appartengono alle regole di discovery specificate.
graphids ID/array Restituisce solo i graph prototype con gli ID specificati.
groupids ID/array Restituisce solo i graph prototype che appartengono agli host o ai template nei gruppi host o template specificati.
hostids ID/array Restituisce solo i graph prototype che appartengono agli host specificati.
inherited boolean Se impostato su true, restituisce solo i graph prototype ereditati da un template.
itemids ID/array Restituisce solo i graph prototype che contengono i prototipi di item specificati.
templated boolean Se impostato su true, restituisce solo i graph prototype che appartengono ai template.
templateids ID/array Restituisce solo i graph prototype che appartengono ai template specificati.
selectDiscoveryRule query Restituisce una proprietà discoveryRule con la regola LLD a cui appartiene il graph prototype.
selectGraphItems query Restituisce una proprietà gitems con gli elementi del graph utilizzati nel graph prototype.
selectHostGroups query Restituisce una proprietà hostgroups con i gruppi host a cui appartiene il graph prototype.
selectHosts query Restituisce una proprietà hosts con gli host a cui appartiene il graph prototype.
selectItems query Restituisce una proprietà items con gli items e i prototipi di item utilizzati nel graph prototype.
selectTemplateGroups query Restituisce una proprietà templategroups con i gruppi template a cui appartiene il graph prototype.
selectTemplates query Restituisce una proprietà templates con i template a cui appartiene il graph prototype.
filter object Restituisce solo i risultati che corrispondono esattamente al filtro specificato.

Accetta un oggetto, in cui le chiavi sono i nomi delle proprietà e i valori sono un singolo valore o un array di valori da confrontare.

Non supporta le proprietà di tipo text data type.

Supporta proprietà aggiuntive:
host - nome tecnico dell'host a cui appartiene il graph prototype;
hostid - ID dell'host a cui appartiene il graph prototype.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: graphid, name, graphtype, discovered.
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Questo parametro è deprecato, usare invece selectHostGroups o selectTemplateGroups.
Restituisce una proprietà groups con i gruppi host e i gruppi template a cui appartiene il graph prototype.

Valori restituiti

(integer/array) Restituisce:

  • un array di oggetti;
  • il numero di oggetti recuperati, se è stato utilizzato il parametro countOutput.

Esempi

Recupero dei prototipi di grafico da una regola LLD

Recupera tutti i prototipi di grafico da una regola LLD.

Request:

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

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "1017",
            "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
}

Vedi anche

Fonte

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