Documentation
Table of Contents
graph.get
Description
graphique entier/tableau.get(paramètres d'objet)
La méthode permet de récupérer des graphiques en fonction des 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 de rôle d'utilisateur. Voir Rôles d'utilisateur 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 | string/array | Renvoie uniquement les graphiques avec les identifiants donnés. |
| groupids | string/array | Renvoie uniquement les graphiques appartenant aux hôtes des groupes d'hôtes donnés. |
| templateids | string/array | Renvoie uniquement les graphiques appartenant aux modèles donnés. |
| hostids | string/array | Renvoie uniquement les graphiques appartenant aux hôtes donnés. |
| itemids | string/array | Renvoie uniquement les graphiques contenant les éléments donnés. |
| templated | boolean | Si la valeur est true, ne renvoie que les graphiques appartenant à des modèles. |
| inherited | boolean | Si la valeur est true, ne renvoie que les graphiques hérités d'un modèle. |
| expandName | flag | Développe les macros dans le nom du graphique. |
| selectGroups | query | Renvoie la propriété groups avec les groupes d'hôtes auxquels appartient le graphique. |
| selectTemplates | query | Renvoie la propriété templates avec les modèles auxquels appartient le graphique. |
| selectHosts | query | Renvoie la propriété hosts avec les hôtes auxquels appartient le graphique. |
| selectItems | query | Renvoie la propriété items avec les éléments utilisés dans le graphique. |
| selectGraphDiscovery | query | Renvoie la propriété graphDiscovery contenant l'objet de découverte de graphique. Les objets de découverte de graphique lient le graphique à un prototype de graphique à partir duquel il a été créé.Il a les propriétés suivantes : graphid - (string) ID du graphique ;parent_graphid - (string) ID du prototype de graphique à partir duquel le graphique a été créé. |
| selectGraphItems | query | Renvoie la propriété gitems avec les éléments utilisés dans le graphique. |
| selectDiscoveryRule | query | Renvoie la propriété discoveryRule avec la règle de découverte de bas niveau qui a créé le graphique. |
| 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 graphique ;hostid - ID de l'hôte auquel appartient le graphique. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : graphid, name et graphtype. |
| countOutput | boolean | Ces 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
(entier/tableau) Renvoie soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa é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"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"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 également
Source
CGraph::get() dans ui/include/classes/api/services/CGraph.php.