15 Carte d’élément
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 Carte d’élément 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 Carte d’élément, 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 Item card.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - Aucun rafraîchissement; 10 - 10 secondes; 30 - 30 secondes; 60 - (par défaut) 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - 15 minutes. |
|
| Item | 4 | itemid.0 | ID de l'élément. Comportement du paramètre: - requis si Item (Widget) n'est pas défini |
|
| Item (Widget) | 1 | itemid._reference | Au lieu de l'ID de l'élément:ABCDE._itemid - définissez un widget compatible (avec son paramètre Reference défini sur "ABCDE") comme source de données pour l'élément.Comportement du paramètre: - requis si Item n'est pas défini |
|
| Show | 0 | sections.0 | 0 - Description; 1 - Texte d'erreur; 2 - Métriques; 3 - Dernières données; 4 - Type d'information; 5 - Déclencheurs; 6 - Interface de l'hôte; 7 - Type; 8 - Inventaire de l'hôte; 9 - Tags. Remarque: Le nombre dans le nom de la propriété fait référence à l'ordre des sections dans la liste des sections. Pour configurer plusieurs sections, créez un objet de champ de widget de tableau de bord pour chaque section avec un numéro incrémenté dans le nom de la propriété. |
|
| Override host | 1 | override_hostid._reference | ABCDE._hostid - définissez un widget compatible (avec son paramètre Reference défini sur "ABCDE") comme source de données pour les hôtes;DASHBOARD._hostid - définissez le sélecteur Hôte du tableau de bord comme source de données pour les hôtes.Par défaut: "" (vide)Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
Sparkline
Les paramètres suivants sont pris en charge si Afficher est défini sur « Dernières données ».
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Largeur | 0 | sparkline.width | Les valeurs possibles vont de 0 à 10. Valeur par défaut : 1. |
|
| Remplissage | 0 | sparkline.fill | Les valeurs possibles vont de 0 à 10. Valeur par défaut : 3. |
|
| Couleur | 1 | sparkline.color | Code couleur hexadécimal (par exemple FF0000).Valeur par défaut : 42A5F5. |
|
| Période | 1 | sparkline.time_period._reference | DASHBOARD._timeperiod - définir le sélecteur de période comme source de données ;ABCDE._timeperiod - définir un widget compatible (avec son paramètre reference défini sur ABCDE) comme source de données.Valeur par défaut : "" (vide)Vous pouvez également définir la période uniquement dans les paramètres Du et Au. |
|
| Du | 1 | sparkline.time_period.from | Chaîne temporelle valide au format absolu (YYYY-MM-DD hh:mm:ss) ou selon la syntaxe temporelle relative (now, now/d, now/w-1w, etc.).Valeur par défaut : now-1h. Comportement du paramètre : - pris en charge si Période n'est pas défini - obligatoire si sparkline.time_period.to est défini |
|
| Au | 1 | sparkline.time_period.to | Chaîne temporelle valide au format absolu (YYYY-MM-DD hh:mm:ss) ou selon la syntaxe temporelle relative (now, now/d, now/w-1w, etc.).Valeur par défaut : now. Comportement du paramètre : - pris en charge si Période n'est pas défini - obligatoire si time_period.from est défini |
|
| Données d'historique | 0 | sparkline.history | 0 - (par défaut) Automatique ; 1 - Historique ; 2 - Tendances. |
|
Exemples
Les exemples suivants visent uniquement à décrire la configuration des objets de champ du widget de tableau de bord pour le widget Item card.
Pour plus d’informations sur la configuration d’un tableau de bord, consultez dashboard.create.
Configuration d’un widget Carte d’élément
Configurez un widget Carte d’élément qui affiche les sections suivantes : « Description », « Dernières données », « Déclencheurs » et « Étiquettes ».
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "itemcard",
"name": "Item card",
"x": 0,
"y": 0,
"width": 14,
"height": 7,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid.0",
"value": 42257
},
{
"type": 0,
"name": "sections.0",
"value": 0
},
{
"type": 0,
"name": "sections.1",
"value": 3
},
{
"type": 0,
"name": "sections.2",
"value": 5
},
{
"type": 0,
"name": "sections.3",
"value": 9
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}