これらのパラメータと、該当するダッシュボードウィジェットフィールドオブジェクトの可能なプロパティ値により、dashboard.createおよびdashboard.updateメソッドでアイテムカードウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新するリスクも生じます。 アイテムカードウィジェットの作成または更新を確実に行うには、以下の表に記載されているパラメータの動作を参照してください。
アイテムカードウィジェットでサポートされているパラメーターは以下の通りです。
| パラメーター | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新しない; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| アイテム | 4 | itemid.0 | アイテムのID。 パラメーターの動作: - Item (Widget)が設定されていない場合は必須 |
|
| Item (Widget) | 1 | itemid._reference | アイテムのIDの代わりに:ABCDE._itemid - 互換性のあるウィジェット(Referenceパラメーターを"ABCDE"に設定)をアイテムのデータソースとして設定します。パラメーターの動作: - Itemが設定されていない場合は必須 |
|
| 表示 | 0 | sections.0 | 0 - 説明; 1 - エラーテキスト; 2 - メトリクス; 3 - 最新データ; 4 - 情報の種類; 5 - トリガー; 6 - ホストインターフェース; 7 - タイプ; 8 - ホストインベントリ; 9 - タグ。 注: プロパティ名の数字はセクションリスト内のセクション順序を参照します。複数のセクションを設定するには、プロパティ名の数字を増やして各セクションごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
|
| ホストの上書き | 1 | override_hostid._reference | ABCDE._hostid - 互換性のあるウィジェット(Referenceパラメーターを"ABCDE"に設定)をホストのデータソースとして設定します;DASHBOARD._hostid - ダッシュボードのホストセレクターをホストのデータソースとして設定します。デフォルト: "" (空)このパラメーターはテンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
表示が「最新データ」に設定されている場合、以下のパラメータがサポートされます。
| パラメータ | type | name | 値 | |
|---|---|---|---|---|
| 幅 | 0 | sparkline.width | 0-10の範囲の値が可能です。 デフォルト: 1. |
|
| 塗りつぶし | 0 | sparkline.fill | 0-10の範囲の値が可能です。 デフォルト: 3. |
|
| 色 | 1 | sparkline.color | 16進数のカラーコード(例: FF0000)。デフォルト: 42A5F5. |
|
| 期間 | 1 | sparkline.time_period._reference | DASHBOARD._timeperiod - ダッシュボードの期間セレクタをデータソースとして設定;ABCDE._timeperiod - 互換性のあるウィジェット(referenceパラメータがABCDEのもの)をデータソースとして設定。デフォルト: ""(空)または、FromおよびToパラメータでのみ期間を設定することもできます。 |
|
| From | 1 | sparkline.time_period.from | 絶対(YYYY-MM-DD hh:mm:ss)または相対時間構文(now、now/d、now/w-1wなど)の有効な時間文字列。デフォルト: now-1h. パラメータの動作: - 期間が設定されていない場合にサポート |
|
| To | 1 | sparkline.time_period.to | 絶対(YYYY-MM-DD hh:mm:ss)または相対時間構文(now、now/d、now/w-1wなど)の有効な時間文字列。デフォルト: now. パラメータの動作: - 期間が設定されていない場合にサポート |
|
| 履歴データ | 0 | sparkline.history | 0 - (デフォルト) 自動; 1 - 履歴; 2 - トレンド。 |
|
以下の例は、アイテムカードウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定のみを説明することを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
これらのセクションを表示するアイテムカードウィジェットを設定します: "説明"、"最新データ"、"トリガー"、"タグ"。
{
"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
}レスポンス: