Documentation
Table of Contents
17 Item value
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでアイテムの値ウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 アイテムの値ウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
Parameters
アイテム値ウィジェットでは、以下のパラメータがサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分 |
|
| Item | 4 | itemid.0 | Item ID パラメーターの動作: - Item (Widget) が設定されていない場合は 必須 です。 |
|
| Item (Widget) | 1 | itemid._reference | Item ID:ABCDE._itemid の代わりに、アイテムのデータソースとして 互換性のあるウィジェット (Reference パラメーターが "ABCDE に設定されている) を設定します。パラメーターの動作: - Item が設定されていない場合は 必須 です。 |
|
| 表示 | 0 | 表示 0 | 1 - 説明 2 - 値 3 - 時間 4 - 変化インジケーター 5 - スパークライン デフォルト: 1、2、3、4 注: 複数の値を設定するには、プロパティ名に増分番号を付けた各値に対してダッシュボードウィジェットフィールドオブジェクトを作成します。 |
|
| ホストの上書き | 1 | override_hostid._reference | ABCDE._hostid - 互換性のあるウィジェット (その Reference パラメータを "ABCDE に設定) をホストのデータ ソースとして設定します。DASHBOARD._hostid - ダッシュボードの ホスト セレクタ をホストのデータ ソースとして設定します。このパラメータは、テンプレート ダッシュボード でウィジェットを構成する場合にはサポートされません。 |
|
詳細設定
Item value ウィジェットでは、以下の詳細設定パラメータがサポートされています。
Thresholds プロパティ名（例：thresholds.0.color）の数字は、リスト内のしきい値の位置を示し、昇順でソートされます。 ただし、しきい値が異なる順序で設定されている場合は、Zabbix フロントエンドでウィジェット設定を更新すると、値は昇順でソートされます。 (例："thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5")
| パラメータ | type | 名前 | 値 | |
|---|---|---|---|---|
| 背景色 | 1 | bg_color | 16進数カラーコード（例：FF0000）デフォルト： ""（空） |
|
| しきい値 | ||||
| 色 | 1 | thresholds.0.color | 16進数カラーコード（例：FF0000） |
|
| しきい値 | 1 | thresholds.0.threshold | 任意の文字列値 | |
| 集計関数 | 0 | aggregate_function | 0 - (デフォルト) 未使用; 1 - 最小; 2 - 最大; 3 - 平均; 4 - 個数; 5 - 合計; 6 - 最初; 7 - 最後 |
|
| 期間 | 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）デフォルト： ""（空） |
Sparkline
表示 が"スパークライン"に設定されている場合、以下の詳細設定パラメータがサポートされます。
| パラメータ | type | 名前 | 値 | |
|---|---|---|---|---|
| 幅 | 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 パラメータでのみ期間を設定することもできます。 |
|
| 開始 | 1 | sparkline.time_period.from | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対 時刻構文 (now、now/d、now/w-1w など) の有効な時刻文字列 |
|
| 終了 | 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
}レスポンス: