Sidebar

fr:manual:api:reference:graphprototype:get

graphprototype.get

Description

integer/array graphprototype.get(object parameters)

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

Paramètres

(object) 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 Renvoie uniquement les prototypes de graphiques appartenant aux règles de découverte données.
graphids string/array Renvoie uniquement les prototypes de graphique avec les identifiants donnés.
groupids string/array Renvoie uniquement les prototypes de graphique appartenant aux hôtes des groupes d'hôtes donnés.
hostids string/array Renvoie uniquement les prototypes de graphique appartenant aux hôtes donnés.
inherited boolean Si la valeur est true, ne renvoie que les prototypes de graphique hérités d'un modèle.
itemids string/array Renvoie uniquement les prototypes de graphique contenant les éléments donnés.
templated boolean Si la valeur est true, ne renvoie que les prototypes de graphique appartenant à des modèles.
templateids string/array Renvoie uniquement les prototypes de graphique appartenant aux modèles donnés.
selectDiscoveryRule query Renvoie la règle de découverte de bas niveau qui a créé le prototype de graphique dans la propriété discoveryRule.
selectGraphItems query Renvoie les éléments de graphique utilisés dans le prototype de graphique dans la propriété gitems.
selectGroups query Renvoie les groupes d'hôtes auxquels le prototype de graphique appartient dans la propriété groups.
selectTemplates query Renvoie les modèles auxquels le prototype de graphique appartient dans la propriété templates.
selectHosts query Renvoie les hôtes auxquels le prototype de graphique appartient dans la propriété hosts.
selectItems query Renvoie les éléments et les prototypes d'éléments utilisés dans le graphique dans la propriété items.
filter object Renvoie uniquement les résultats qui correspondent exactement au filtre donné.

Accepte un tableau dans lequel les clés sont des noms de propriétés et les valeurs sont une valeur unique ou un tableau de valeurs à comparer.

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

Les valeurs possibles sont : graphid, name et graphtype.
countOutput booleanCes paramètres, communs à toutes les méthodes “get”, sont décrits dans les commentaires 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

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 de prototypes de graphique à partir d'une règle de découverte bas niveau

Récupérer tous les prototypes de graphique d'une règle de découverte bas niveau.

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"
        }
    ],
    "id": 1
}

Voir également

Source

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