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.

Paramètre Type Description
graphids ID/array Retourner uniquement les graphiques avec les ID donnés.
groupids ID/array Retourner uniquement les graphiques 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 Retourner uniquement les graphiques qui appartiennent aux modèles donnés.
hostids ID/array Retourner uniquement les graphiques qui appartiennent aux hôtes donnés.
itemids ID/array Retourner uniquement les graphiques qui contiennent les éléments donnés.
templated boolean Si défini sur true, retourner uniquement les graphiques qui appartiennent à des modèles.
inherited boolean Si défini sur true, retourner uniquement les graphiques hérités d'un modèle.
expandName flag Développer les macros dans le nom du graphique.
selectDiscoveryData query Retourner une propriété discoveryData avec les données de l'objet de découverte du graphique. L'objet de découverte du graphique relie un graphique découvert à un prototype de graphique à partir duquel il a été découvert.

Il possède les propriétés suivantes :
parent_graphid - (ID) ID du prototype de graphique à partir duquel le graphique a été créé ;
status - (int) statut de découverte du graphique :
0 - (par défaut) le graphique est découvert,
1 - le graphique n'est plus découvert ;
ts_delete - (timestamp) heure à laquelle un graphique qui n'est plus découvert sera supprimé.
selectDiscoveryRule query Retourner une propriété discoveryRule avec la règle de découverte de bas niveau qui a créé le graphique.
selectHostGroups query Retourner une propriété hostgroups avec les groupes d'hôtes auxquels le graphique appartient.
selectTemplateGroups query Retourner une propriété templategroups avec les groupes de modèles auxquels le graphique appartient.
selectTemplates query Retourner une propriété templates avec les modèles auxquels le graphique appartient.
selectHosts query Retourner une propriété hosts avec les hôtes auxquels le graphique appartient.
selectItems query Retourner une propriété items avec les éléments utilisés dans le graphique.
selectGraphItems query Retourner une propriété gitems avec les éléments utilisés dans le graphique.
filter object Retourner uniquement les résultats qui correspondent exactement au filtre donné.

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

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 graphique appartient ;
hostid - ID de l'hôte auquel le graphique appartient.
sortfield string/array Trier 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
selectGraphDiscovery query Retourner une propriété graphDiscovery avec l'objet de découverte du graphique. Les objets de découverte du graphique relient le graphique à un prototype de graphique à partir duquel il a été créé.

Cette requête est obsolète, veuillez utiliser selectDiscoveryData à la place.

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.