10 Prototype de graphique
Description
Ces paramètres et les valeurs de propriété possibles pour les objets de champ du widget de tableau de bord respectifs permettent de configurer le widget Graph prototype dans les méthodes dashboard.create et dashboard.update.
Les propriétés fields du widget ne sont pas validées lors de la création ou de la mise à jour d’un tableau de bord.
Cela permet aux utilisateurs de modifier les widgets intégrés et de créer des widgets personnalisés, mais introduit également le risque de créer ou de mettre à jour des widgets de manière incorrecte.
Pour garantir la réussite de la création ou de la mise à jour du widget Graph prototype, veuillez vous référer au comportement des paramètres décrit dans les tableaux ci-dessous.
Paramètres
Les paramètres suivants sont pris en charge pour le widget Prototype de graphique.
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Intervalle d’actualisation | 0 | rf_rate | 0 - Aucune actualisation; 10 - 10 secondes; 30 - 30 secondes; 60 - (par défaut) 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - 15 minutes. |
|
| Source | 0 | source_type | 2 - (par défaut) Prototype de graphique; 3 - Prototype de graphique simple. |
|
| Prototype de graphique | 7 | graphid.0 | ID du prototype de graphique. Comportement du paramètre : - obligatoire si Source est définie sur « Prototype de graphique » |
|
| Prototype d’élément | 5 | itemid.0 | ID du prototype d’élément. Comportement du paramètre : - obligatoire si Source est définie sur « Prototype de graphique simple » |
|
| Période | 1 | time_period._reference | DASHBOARD._timeperiod - définir le sélecteur de période du tableau de bord comme source de données ;ABCDE._timeperiod - définir un widget compatible (avec son paramètre Référence défini sur « ABCDE ») comme source de données.Par défaut : DASHBOARD._timeperiodVous pouvez également définir la période uniquement dans les paramètres De et À. |
|
| De | 1 | time_period.from | Chaîne temporelle valide en syntaxe temporelle absolue (YYYY-MM-DD hh:mm:ss) ou relative (now, now/d, now/w-1w, etc.).Comportement du paramètre : - pris en charge si Période n’est pas définie - obligatoire si time_period.to est défini |
|
| À | 1 | time_period.to | Chaîne temporelle valide en syntaxe temporelle absolue (YYYY-MM-DD hh:mm:ss) ou relative (now, now/d, now/w-1w, etc.).Comportement du paramètre : - pris en charge si Période n’est pas définie - obligatoire si time_period.from est défini |
|
| Afficher la légende | 0 | show_legend | 0 - Désactivé ; 1 - (par défaut) Activé. |
|
| Remplacer l’hôte | 1 | override_hostid._reference | ABCDE._hostid - définir un widget compatible (avec son paramètre Référence défini sur « ABCDE ») comme source de données pour les hôtes ;DASHBOARD._hostid - définir le sélecteur d’hôte du tableau de bord comme source de données pour les hôtes.Ce paramètre n’est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Colonnes | 0 | columns | Les valeurs possibles vont de 1 à 24. Par défaut : 2. |
|
| Lignes | 0 | rows | Les valeurs possibles vont de 1 à 16. Par défaut : 1. |
|
| Référence | 1 | reference | Toute valeur de chaîne composée de 5 caractères (par exemple, ABCDE ou JBPNL). Cette valeur doit être unique dans le tableau de bord auquel appartient le widget.Comportement du paramètre : - obligatoire |
|
Exemples
Les exemples suivants visent à décrire uniquement la configuration des objets de champ du widget de tableau de bord pour le widget Prototype de graphique.
Pour plus d'informations sur la configuration d'un tableau de bord, consultez dashboard.create.
Configuration d'un widget Prototype de graphique
Configurez un widget Prototype de graphique qui affiche une grille de 3 graphiques (3 colonnes, 1 ligne) créés à partir d'un prototype d'élément (ID : "42316") par découverte de bas niveau.
Requête :
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "graphprototype",
"name": "Graph prototype",
"x": 0,
"y": 0,
"width": 48,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 3
},
{
"type": 5,
"name": "itemid.0",
"value": 42316
},
{
"type": 0,
"name": "columns",
"value": 3
},
{
"type": 1,
"name": "reference",
"value": "OPQWX"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}