Documentation
Table of Contents
graphprototype.get
Description
integer/array graphprototype.get(object parameters)
La m¨¦thode permet de r¨¦cup¨¦rer des prototypes de graphiques en fonction des param¨¨tres donn¨¦s.
Cette m¨¦thode est disponible ¨¤ tous les types d'utilisateurs. Les autorisations d'appeler la m¨¦thode peuvent ¨ºtre r¨¦voqu¨¦es dans les param¨¨tres du le r?le d'utilisateur. Voir R?les Utilisateur pour plus d'informations.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(objet) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| discoveryids | string/array | Renvoyer uniquement les prototypes de graphe qui appartiennent aux r¨¨gles de d¨¦couverte donn¨¦es. |
| graphids | string/array | Renvoyer uniquement les prototypes de graphe avec les ID donn¨¦s. |
| groupids | string/array | Renvoyer uniquement les prototypes de graphe qui appartiennent aux h?tes dans les groupes d'h?tes donn¨¦s. |
| hostids | string/array | Renvoyer uniquement les prototypes de graphe qui appartiennent aux h?tes donn¨¦s. |
| inherited | boolean | Si d¨¦fini sur true, ne renvoie que les prototypes de graphe h¨¦rit¨¦s d'un mod¨¨le. |
| itemids | string/array | Renvoyer uniquement les prototypes de graphes contenant les prototypes d'¨¦l¨¦ments donn¨¦s. |
| templed | boolean | Si d¨¦fini sur true, ne renvoie que les prototypes de graphe appartenant aux mod¨¨les. |
| templateids | string/array | Renvoyer uniquement les prototypes de graphe qui appartiennent aux mod¨¨les donn¨¦s. |
| selectDiscoveryRule | query | Renvoie une propri¨¦t¨¦ discoveryRule avec la r¨¨gle LLD ¨¤ laquelle appartient le prototype de graphe. |
| selectGraphItems | query | Renvoie une propri¨¦t¨¦ gitems avec les ¨¦l¨¦ments de graphe utilis¨¦s dans le prototype de graphe. |
| selectGroups | query | Renvoie une propri¨¦t¨¦ groups avec les groupes d'h?tes auxquels appartient le prototype de graphe. |
| selectHosts | query | Renvoie une propri¨¦t¨¦ hosts avec les h?tes auxquels appartient le prototype de graphe. |
| selectItems | query | Renvoyer une propri¨¦t¨¦ items avec les items et item prototypes utilis¨¦s dans le prototype de graphe . |
| selectTemplates | query | Renvoie une propri¨¦t¨¦ templates avec les mod¨¨les auxquels appartient le prototype de graphe. |
| filter | object | Renvoyer uniquement les r¨¦sultats qui correspondent exactement au filtre donn¨¦. Accepte un tableau, o¨´ les cl¨¦s sont des noms de propri¨¦t¨¦ et les valeurs sont soit une valeur unique, soit un tableau de valeurs ¨¤ comparer. Prend en charge des filtres suppl¨¦mentaires : host - nom technique de l'h?te auquel appartient le prototype de graphe ;hostid - ID de l'h?te auquel appartient le prototype de graphe. |
| sortfield | string/array | Trier le r¨¦sultat selon les propri¨¦t¨¦s donn¨¦es. Les valeurs possibles sont : graphid, name et graphtype. |
| countOutput | boolean | Ces param¨¨tres ¨¦tant communs ¨¤ toutes les m¨¦thodes get, ils sont d¨¦crits en d¨¦tail dans le commentaire de r¨¦f¨¦rence. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | entier | |
| output | °ù±ð±ç³Ü¨º³Ù±ð | |
| preservekeys | boolean | |
| search | objet | |
| 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
countOutputa ¨¦t¨¦ utilis¨¦.
Exemples
R¨¦cup¨¦ration des prototypes de graphes ¨¤ partir d'une r¨¨gle LLD
R¨¦cup¨¦rez tous les prototypes de graphe d'une r¨¨gle LLD.
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",
"discover": "0"
}
],
"id": 1
}Voir ¨¦galement
Source
CGraphPrototype::get() dans ui/include/classes/api/services/CGraphPrototype.php.