Table of Contents
18 アイテム値
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、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 | show.0 | 1 - 説明; 2 - 値; 3 - 時刻; 4 - 変化インジケーター; 5 - スパークライン。 デフォルト: 1, 2, 3, 4。 注: 複数の値を設定するには、各値ごとにプロパティ名の番号を増やしてダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
|
| ホストの上書き | 1 | override_hostid._reference | ABCDE._hostid - 互換性のあるウィジェット（Referenceパラメーターを"ABCDE"に設定）をホストのデータソースとして設定します;DASHBOARD._hostid - ダッシュボードのホストセレクターをホストのデータソースとして設定します。このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
高度な設定
アイテム値ウィジェットでは、以下の高度な設定パラメータがサポートされています。
しきい値プロパティ名の数字（例：thresholds.0.color）は、昇順でソートされたリスト内のしきい値の位置を参照します。 ただし、しきい値が異なる順序で設定されている場合、Zabbixフロントエンドでウィジェット設定を更新した後、値は昇順にソートされます （例："thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5"）。
| パラメータ | type | name | 値 | |
|---|---|---|---|---|
| 背景色 | 1 | bg_color | 16進数のカラーコード（例：FF0000）。デフォルト： ""（空）。 |
|
| しきい値 | ||||
| 色 | 1 | thresholds.0.color | 16進数のカラーコード（例：FF0000）。 |
|
| しきい値 | 1 | thresholds.0.threshold | 任意の文字列値。 | |
| 集約関数 | 0 | aggregate_function | 0 - (デフォルト) 使用しない; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| 期間 | 1 | time_period._reference | DASHBOARD._timeperiod - ダッシュボードの期間セレクターをデータソースとして設定;ABCDE._timeperiod - 互換性のあるウィジェット（そのreferenceパラメータがABCDEであるもの）をデータソースとして設定。デフォルト： DASHBOARD._timeperiodまたは、FromおよびToパラメータのみで期間を設定することもできます。 パラメータの動作： - 集約関数が「min」「max」「avg」「count」「sum」「first」「last」に設定されている場合にサポート |
|
| From | 1 | time_period.from | 絶対（YYYY-MM-DD hh:mm:ss）または相対時間構文（now、now/d、now/w-1wなど）の有効な時間文字列。パラメータの動作： - 期間が設定されておらず、集約関数が「min」「max」「avg」「count」「sum」「first」「last」に設定されている場合にサポート |
|
| To | 1 | time_period.to | 絶対（YYYY-MM-DD hh:mm:ss）または相対時間構文（now、now/d、now/w-1wなど）の有効な時間文字列。パラメータの動作： - 期間が設定されておらず、集約関数が「min」「max」「avg」「count」「sum」「first」「last」に設定されている場合にサポート |
|
| 履歴データ | 0 | history | 0 - (デフォルト) 自動; 1 - 履歴; 2 - トレンド。 |
|
Description
表示が"説明"に設定されている場合、以下の詳細設定パラメータがサポートされます。
| パラメータ | type | 名前 | 値 |
|---|---|---|---|
| 説明 | 1 | 説明 | マクロを含む任意の文字列値 サポートされているマクロ: {HOST.*}、{ITEM.*}、{INVENTORY.*}、ユーザーマクロ デフォルト: {ITEM.NAME} |
| 水平位置 | 0 | desc_h_pos | 0 - 左 1 - (デフォルト) 中央 2 - 右 2つ以上の要素 (説明、値、時間) で同じ 水平位置 と 垂直位置 を共有することはできません。 |
| 垂直位置 | 0 | desc_v_pos | 0 - 上; 1 - 中央; 2 - (デフォルト) 下 2 つ以上の要素 (説明、値、時刻) が同じ 水平位置 と 垂直位置 を共有することはできません。 |
| サイズ | 0 | desc_size | 指定可能な値の範囲は 1～100 です。 デフォルト: 15 |
| 太字 | 0 | desc_bold | 0 - (デフォルト) 無効; 1 - 有効 |
| 色 | 1 | desc_color | 16 進数のカラーコード (例: FF0000)デフォルト: "" (空) |
Value
表示が"値"に設定されている場合、以下の詳細設定パラメータがサポートされます。
| パラメータ | type | 名前 | 値 | |
|---|---|---|---|---|
| 小数点以下の桁数 | ||||
| 小数点以下の桁数 | 0 | decimal_places | 有効な値の範囲は1～10です。 デフォルト: 2 |
|
| サイズ | 0 | decimal_size | 有効な値の範囲は1～100です。 デフォルト: 35 |
|
| 位置 | ||||
| 水平位置 | 0 | value_h_pos | 0 - 左; 1 - (デフォルト) 中央; 2 - 右 2 つ以上の要素 (説明、値、時間) が同じ 水平位置 と 垂直位置 を共有することはできません。 |
|
| 垂直位置 | 0 | value_v_pos | 0 - 上; 1 - (デフォルト) 中央; 2 - 下 2 つ以上の要素 (説明、値、時間) が同じ 水平位置 と 垂直位置 を共有することはできません。 |
|
| サイズ | 0 | value_size | 有効な値の範囲は 1～100 です。 デフォルト: 45 |
|
| 太字 | 0 | value_bold | 0 - 無効; 1 - (デフォルト) 有効 |
|
| 色 | 1 | 値_色 | 16進数のカラーコード（例：FF0000）デフォルト： ""（空） |
|
| 単位 | ||||
| 単位（チェックボックス） | 0 | 単位表示 | 0 - 無効 1 - （デフォルト） 有効 |
|
| 単位（値） | 1 | 単位 | 任意の文字列値 | |
| 位置 | 0 | 単位_位置 | 0 - 前の値 1 - 上の値 2 - （デフォルト） 後の値 3 - 下の値 |
|
| サイズ | 0 | 単位_サイズ | 可能な値の範囲は1～100です。 デフォルト：35 |
|
| 太字 | 0 | units_bold | 0 - 無効; 1 - (デフォルト) 有効 |
|
| 色 | 1 | units_color | 16進数の色コード (例: FF0000)デフォルト: "" (空) |
|
時間
表示が"時間"に設定されている場合、以下の詳細設定パラメータがサポートされます。
| パラメータ | type | 名前 | 値 |
|---|---|---|---|
| 水平位置 | 0 | time_h_pos | 0 - 左; 1 - (デフォルト) 中央; 2 - 右 2つ以上の要素（説明、値、時間）が同じ水平位置と垂直位置を共有することはできません。 |
| 垂直位置 | 0 | time_v_pos | 0 - (デフォルト) 上; 1 - 中央; 2 - 下 2つ以上の要素（説明、値、時間）が同じ水平位置と垂直位置を共有することはできません。 |
| サイズ | 0 | time_size | 指定可能な値の範囲は1～100です。 デフォルト: 15 |
| 太字 | 0 | time_bold | 0 - (デフォルト) 無効 1 - 有効 |
| 色 | 1 | time_color | 16進数のカラーコード(例: FF0000)デフォルト: "" (空) |
変更インジケーター
表示が"変更インジケーター"に設定されている場合、以下の詳細設定パラメータがサポートされます。
| パラメータ | type | 名前 | 値 |
|---|---|---|---|
| 変更インジケーター↑の色 | 1 | up_color | 16進数カラーコード（例：FF0000）デフォルト： ""（空） |
| 変更インジケーター↓の色 | 1 | down_color | 16進数カラーコード（例：FF0000）デフォルト： ""（空） |
| インジケーターの色変更 | 1 | updown_color | 16進数カラーコード（例：FF0000）デフォルト： ""（空） |
スパークライン
表示が「スパークライン」に設定されている場合、以下の詳細な設定パラメータがサポートされます。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 幅 | 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のもの）をデータソースとして設定します。デフォルト: DASHBOARD._timeperiodまたは、FromおよびToパラメータで期間のみを設定することもできます。 |
|
| From | 1 | sparkline.time_period.from | 絶対（YYYY-MM-DD hh:mm:ss）または相対時間構文（now、now/d、now/w-1wなど）での有効な時間文字列。 |
|
| To | 1 | sparkline.time_period.to | 絶対（YYYY-MM-DD hh:mm:ss）または相対時間構文（now、now/d、now/w-1wなど）での有効な時間文字列。 |
|
| 履歴データ | 0 | sparkline.history | 0 - (デフォルト) 自動; 1 - 履歴; 2 - トレンド。 |
|
例
次の例は、アイテムの値ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
アイテムの値ウィジェットの設定
アイテム"42266"(Zabbixエージェントの可用性)のアイテム値を表示するアイテムの値ウィジェットを設定します。さらにウィジェットを複数の詳細オプションを使用して、Zabbixエージェントの可用性ステータスに基づいて変更される動的な背景色といった視覚的な調整をします。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "item",
"name": "Item value",
"x": 0,
"y": 0,
"width": 12,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid.0",
"value": 42266
},
{
"type": 0,
"name": "show.0",
"value": 1
},
{
"type": 0,
"name": "show.1",
"value": 2
},
{
"type": 0,
"name": "show.2",
"value": 3
},
{
"type": 1,
"name": "description",
"value": "Agent status"
},
{
"type": 0,
"name": "desc_h_pos",
"value": 0
},
{
"type": 0,
"name": "desc_v_pos",
"value": 0
},
{
"type": 0,
"name": "desc_bold",
"value": 1
},
{
"type": 1,
"name": "desc_color",
"value": "F06291"
},
{
"type": 0,
"name": "value_h_pos",
"value": 0
},
{
"type": 0,
"name": "value_size",
"value": 25
},
{
"type": 1,
"name": "value_color",
"value": "FFFF00"
},
{
"type": 0,
"name": "units_show",
"value": 0
},
{
"type": 0,
"name": "time_h_pos",
"value": 2
},
{
"type": 0,
"name": "time_v_pos",
"value": 2
},
{
"type": 0,
"name": "time_size",
"value": 10
},
{
"type": 0,
"name": "time_bold",
"value": 1
},
{
"type": 1,
"name": "time_color",
"value": "9FA8DA"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "E1E1E1"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "0"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "D1C4E9"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "1"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: