Documentation
Table of Contents
graphprototype.get
Description
integer/array graphprototype.get(object parameters)
La m¨¦thode permet de r¨¦cup¨¦rer des prototypes de graphique en fonction des param¨¨tres donn¨¦s.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| discoveryids | string/array | Renvoie uniquement les prototypes de graphiques appartenant aux r¨¨gles de d¨¦couverte donn¨¦es. |
| graphids | string/array | Renvoie uniquement les prototypes de graphique avec les identifiants donn¨¦s. |
| groupids | string/array | Renvoie uniquement les prototypes de graphique appartenant aux h?tes des groupes d'h?tes donn¨¦s. |
| hostids | string/array | Renvoie uniquement les prototypes de graphique appartenant aux h?tes donn¨¦s. |
| inherited | boolean | Si la valeur est true, ne renvoie que les prototypes de graphique h¨¦rit¨¦s d'un mod¨¨le. |
| itemids | string/array | Renvoie uniquement les prototypes de graphique contenant les ¨¦l¨¦ments donn¨¦s. |
| templated | boolean | Si la valeur est true, ne renvoie que les prototypes de graphique appartenant ¨¤ des mod¨¨les. |
| templateids | string/array | Renvoie uniquement les prototypes de graphique appartenant aux mod¨¨les donn¨¦s. |
| selectDiscoveryRule | query | Renvoie la r¨¨gle de d¨¦couverte de bas niveau qui a cr¨¦¨¦ le prototype de graphique dans la propri¨¦t¨¦ discoveryRule. |
| selectGraphItems | query | Renvoie les ¨¦l¨¦ments de graphique utilis¨¦s dans le prototype de graphique dans la propri¨¦t¨¦ gitems. |
| selectGroups | query | Renvoie les groupes d'h?tes auxquels le prototype de graphique appartient dans la propri¨¦t¨¦ groups. |
| selectTemplates | query | Renvoie les mod¨¨les auxquels le prototype de graphique appartient dans la propri¨¦t¨¦ templates. |
| selectHosts | query | Renvoie les h?tes auxquels le prototype de graphique appartient dans la propri¨¦t¨¦ hosts. |
| selectItems | query | Renvoie les ¨¦l¨¦ments et les prototypes d'¨¦l¨¦ments utilis¨¦s dans le graphique dans la propri¨¦t¨¦ items. |
| 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 prototype de grzaphique ;hostid - ID de l'h?te auquel appartient le prototype de 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
(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 de prototypes de graphique ¨¤ partir d'une r¨¨gle de d¨¦couverte bas niveau
R¨¦cup¨¦rer tous les prototypes de graphique d'une r¨¨gle de d¨¦couverte bas niveau.
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"
}
],
"id": 1
}Voir ¨¦galement
- R¨¨gle de d¨¦couverte bas niveau
- ?±ô¨¦³¾±ð²Ô³Ù de graphique
- ?±ô¨¦³¾±ð²Ô³Ù
- H?te
- Groupe d'H?te
- ²Ñ´Ç»å¨¨±ô±ð
Source
CGraphPrototype::get() dans frontends/php/include/classes/api/services/CGraphPrototype.php.