graph.get

Description

integer/array graph.get(object parameters)

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

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appeler 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
graphids ID/array Retourne uniquement les graphes avec les IDs donnés.
groupids ID/array Retourne uniquement les graphes qui appartiennent à des hôtes ou des modèles dans les groupes d'hôtes ou groupes de modèles donnés.
templateids ID/array Retourne uniquement les graphes qui appartiennent aux modèles donnés.
hostids ID/array Retourne uniquement les graphes qui appartiennent aux hôtes donnés.
itemids ID/array Retourne uniquement les graphes qui contiennent les éléments donnés.
templated boolean Si défini sur true, retourne uniquement les graphes qui appartiennent à des modèles.
inherited boolean Si défini sur true, retourne uniquement les graphes hérités d'un modèle.
expandName flag Développe les macros dans le nom du graphe.
selectHostGroups query Retourne une propriété hostgroups avec les groupes d'hôtes auxquels le graphe appartient.
selectTemplateGroups query Retourne une propriété templategroups avec les groupes de modèles auxquels le graphe appartient.
selectTemplates query Retourne une propriété templates avec les modèles auxquels le graphe appartient.
selectHosts query Retourne une propriété hosts avec les hôtes auxquels le graphe appartient.
selectItems query Retourne une propriété items avec les éléments utilisés dans le graphe.
selectGraphDiscovery query Retourne une propriété graphDiscovery avec l'objet de découverte du graphe. Les objets de découverte du graphe lient le graphe à un prototype de graphe à partir duquel il a été créé.

Il possède les propriétés suivantes :
graphid - (ID) ID du graphe;
parent_graphid - (ID) ID du prototype de graphe à partir duquel le graphe a été créé;
lastcheck - (timestamp) heure à laquelle le graphe a été découvert pour la dernière fois;
status - (int) statut de découverte du graphe :
0 - (par défaut) le graphe est découvert,
1 - le graphe n'est plus découvert;
ts_delete - (timestamp) heure à laquelle un graphe qui n'est plus découvert sera supprimé.
selectGraphItems query Retourne une propriété gitems avec les éléments utilisés dans le graphe.
selectDiscoveryRule query Retourne une propriété discoveryRule avec la règle de découverte bas niveau qui a créé le graphe.
filter object Retourne uniquement les résultats qui correspondent 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 le graphe appartient;
hostid - ID de l'hôte auquel le graphe appartient.
sortfield string/array Trie le résultat selon les propriétés données.

Valeurs possibles : graphid, name, graphtype.
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.
Retourne une propriété groups avec les groupes d'hôtes et les groupes de modèles auxquels le graphe appartient.

Valeurs retournées

(entier/tableau) Renvoie 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 graphiques des hôtes

Récupérez tous les graphiques de l'hôte "10107" et triez-les par nom.

Requête:

{
    "jsonrpc": "2.0",
    "method": "graph.get",
    "params": {
        "output": "extend",
        "hostids": 10107,
        "sortfield": "name"
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "612",
            "name": "CPU jumps",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "439",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "613",
            "name": "CPU load",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "433",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "614",
            "name": "CPU utilization",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "387",
            "show_work_period": "1",
            "show_triggers": "0",
            "graphtype": "1",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "1",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "645",
            "name": "Disk space usage /",
            "width": "600",
            "height": "340",
            "yaxismin": "0",
            "yaxismax": "0",
            "templateid": "0",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "4"
        }
    ],
    "id": 1
}

Voir aussi

Source

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