graphprototype.get

Description

integer/array graphprototype.get(object parameters)

La méthode permet de récupérer des prototypes de graphiques en fonction des paramètres donnés.

Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.

Paramètres

(objet) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Paramètre	Type	Description
discoveryids	string/array	Renvoyer uniquement les prototypes de graphe qui appartiennent aux règles de découverte données.
graphids	string/array	Renvoyer uniquement les prototypes de graphe avec les ID donnés.
groupids	string/array	Renvoyer uniquement les prototypes de graphe qui appartiennent aux hôtes dans les groupes d'hôtes donnés.
hostids	string/array	Renvoyer uniquement les prototypes de graphe qui appartiennent aux hôtes donnés.
inherited	boolean	Si défini sur `true`, ne renvoie que les prototypes de graphe hérités d'un modèle.
itemids	string/array	Renvoyer uniquement les prototypes de graphes contenant les prototypes d'éléments donnés.
templed	boolean	Si défini sur `true`, ne renvoie que les prototypes de graphe appartenant aux modèles.
templateids	string/array	Renvoyer uniquement les prototypes de graphe qui appartiennent aux modèles donnés.
selectDiscoveryRule	query	Renvoie une propriété discoveryRule avec la règle LLD à laquelle appartient le prototype de graphe.
selectGraphItems	query	Renvoie une propriété gitems avec les éléments de graphe utilisés dans le prototype de graphe.
selectGroups	query	Renvoie une propriété groups avec les groupes d'hôtes auxquels appartient le prototype de graphe.
selectHosts	query	Renvoie une propriété hosts avec les hôtes auxquels appartient le prototype de graphe.
selectItems	query	Renvoyer une propriété `items` avec les items et item prototypes utilisés dans le prototype de graphe .
selectTemplates	query	Renvoie une propriété templates avec les modèles auxquels appartient le prototype de graphe.
filter	object	Renvoyer uniquement les résultats qui correspondent exactement au filtre donné. Accepte un tableau, où les clés sont des noms de propriété et les valeurs sont soit une valeur unique, soit un tableau de valeurs à comparer. Prend en charge des filtres supplémentaires : `host` - nom technique de l'hôte auquel appartient le prototype de graphe ; `hostid` - ID de l'hôte auquel appartient le prototype de graphe.
sortfield	string/array	Trier le résultat selon les propriétés données. Les valeurs possibles sont : `graphid`, `name` et `graphtype`.
countOutput	boolean	Ces paramètres étant communs à toutes les méthodes `get`, ils sont décrits en détail dans le commentaire de référence.
editable	boolean
excludeSearch	boolean
limit	entier
output	requête
preservekeys	boolean
search	objet
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valeurs retournées

(integer/array) Retourne soit :

un tableau d'objets ;
le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération des prototypes de graphes à partir d'une règle LLD

Récupérez tous les prototypes de graphe d'une règle LLD.

Requête :

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

Réponse :

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

Voir également

Source

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

Documentation