graphprototype.get

Description

integer/array graphprototype.get(object parameters)

Cette méthode permet de récupérer des prototypes de graphiques selon les paramètres donnés.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.

Paramètres

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

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

Parameter Type Description
discoveryids ID/array Ne renvoyer que les prototypes de graphique appartenant aux règles de découverte données.
graphids ID/array Ne renvoyer que les prototypes de graphique avec les ID donnés.
groupids ID/array Ne renvoyer que les prototypes de graphique appartenant à des hôtes ou des modèles dans les groupes d'hôtes ou groupes de modèles donnés.
hostids ID/array Ne renvoyer que les prototypes de graphique appartenant aux hôtes donnés.
inherited boolean Si défini sur true, ne renvoyer que les prototypes de graphique hérités d'un modèle.
itemids ID/array Ne renvoyer que les prototypes de graphique contenant les prototypes d'élément donnés.
templated boolean Si défini sur true, ne renvoyer que les prototypes de graphique appartenant à des modèles.
templateids ID/array Ne renvoyer que les prototypes de graphique appartenant aux modèles donnés.
selectDiscoveryRule query Renvoyer une propriété discoveryRule avec la règle LLD à laquelle appartient le prototype de graphique.
selectGraphItems query Renvoyer une propriété gitems avec les éléments de graphique utilisés dans le prototype de graphique.
selectHostGroups query Renvoyer une propriété hostgroups avec les groupes d'hôtes auxquels appartient le prototype de graphique.
selectHosts query Renvoyer une propriété hosts avec les hôtes auxquels appartient le prototype de graphique.
selectItems query Renvoyer une propriété items avec les éléments et prototypes d'élément utilisés dans le prototype de graphique.
selectTemplateGroups query Renvoyer une propriété templategroups avec les groupes de modèles auxquels appartient le prototype de graphique.
selectTemplates query Renvoyer une propriété templates avec les modèles auxquels appartient le prototype de graphique.
filter object Ne renvoyer que les résultats correspondant exactement au filtre donné.

Accepte un objet, où les clés sont des noms de propriétés et les valeurs sont soit une valeur unique, soit un tableau de valeurs à comparer.

Ne prend pas en charge les propriétés de type de données text data type.

Prend en charge des propriétés supplémentaires :
host - nom technique de l'hôte auquel appartient le prototype de graphique;
hostid - ID de l'hôte auquel appartient le prototype de graphique.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : graphid, name, graphtype, discovered.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Ce paramètre est obsolète, veuillez utiliser selectHostGroups ou selectTemplateGroups à la place.
Renvoyer une propriété groups avec les groupes d'hôtes et les groupes de modèles auxquels appartient le prototype de graphique.

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 graphique à partir d'une règle LLD

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

Requête :

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

Réponse :

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

Voir aussi

Source

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