Sidebar

fr:manual:api:reference:graphitem:get

graphitem.get

Description

integer/array graphitem.get(object parameters)

La méthode permet de récupérer des éléments 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
graphids string/array Renvoie uniquement les éléments de graphique appartenant aux graphiques donnés.
itemids string/array Renvoie uniquement les éléments de graphique avec les ID d'élément donnés.
type integer Renvoie uniquement les éléments de graphique avec le type donné.

Se référer à la page de l'objet Élément de graphique pour une liste des types d'élément de graphique pris en charge.
selectGraphs query Renvoie les graphiques auxquels appartient l'élément sous forme de tableau dans la propriété graphs.
sortfield string/array Trie le résultat par les propriétés données.

Les valeurs possibles sont : gitemid.
countOutput booleanCes paramètres, communs à toutes les méthodes “get”, sont décrits dans les commentaires de référence.
editable boolean
limit integer
output query
preservekeys boolean
sortorder string/array

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 éléments de graphiques d'un graphique donné

Récupérer tous les éléments de graphique utilisés dans un graphique avec des informations supplémentaires sur l'élément et l'hôte.

Requête :

{
    "jsonrpc": "2.0",
    "method": "graphitem.get",
    "params": {
        "output": "extend",
        "graphids": "387"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "gitemid": "1242",
            "graphid": "387",
            "itemid": "22665",
            "drawtype": "1",
            "sortorder": "1",
            "color": "FF5555",
            "yaxisside": "0",
            "calc_fnc": "2",
            "type": "0",
            "key_": "system.cpu.util[,steal]",
            "hostid": "10001",
            "flags": "0",
            "host": "Template OS Linux"
        },
        {
            "gitemid": "1243",
            "graphid": "387",
            "itemid": "22668",
            "drawtype": "1",
            "sortorder": "2",
            "color": "55FF55",
            "yaxisside": "0",
            "calc_fnc": "2",
            "type": "0",
            "key_": "system.cpu.util[,softirq]",
            "hostid": "10001",
            "flags": "0",
            "host": "Template OS Linux"
        },
        {
            "gitemid": "1244",
            "graphid": "387",
            "itemid": "22671",
            "drawtype": "1",
            "sortorder": "3",
            "color": "009999",
            "yaxisside": "0",
            "calc_fnc": "2",
            "type": "0",
            "key_": "system.cpu.util[,interrupt]",
            "hostid": "10001",
            "flags": "0",
            "host": "Template OS Linux"
        }
    ],
    "id": 1
}

Voir également

Source

CGraphItem::get() in frontends/php/include/classes/api/services/CGraphItem.php.