6 Gauge
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでゲージウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。
これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。
ゲージウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメータ
以下のパラメータは、Gauge ウィジェットでサポートされています。
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (default) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| Item | 4 | itemid.0 | アイテム ID。 パラメータの動作: - required if Item (Widget) is not set |
|
| Item (Widget) | 1 | itemid._reference | アイテム ID の代わりに、ABCDE._itemid - 互換ウィジェット（Reference パラメータを "ABCDE" に設定したもの）をアイテムのデータソースとして設定します。パラメータの動作: - required if Item is not set |
|
| Min | 1 | min | 任意の数値。 サフィックス（例: "1d"、"2w"、"4K"、"8G"）がサポートされています。 デフォルト: "0"。 |
|
| Max | 1 | max | 任意の数値。 サフィックス（例: "1d"、"2w"、"4K"、"8G"）がサポートされています。 デフォルト: "100"。 |
|
| Value arc | 1 | value_arc_color | 16進数のカラーコード（例: FF0000）。デフォルト: ""（空）。 |
|
| Arc background | 1 | empty_color | 16進数のカラーコード（例: FF0000）。デフォルト: ""（空）。 |
|
| Background | 1 | bg_color | 16進数のカラーコード（例: FF0000）。デフォルト: ""（空）。 |
|
| Show | 0 | show.0 | 1 - 説明; 2 - 値; 3 - 針; 4 - スケール; 5 - 値のアーク。 注: 複数の値を設定するには、各値ごとに dashboard widget field オブジェクトを作成し、プロパティ名の番号を増やしてください。 デフォルト: 1, 2, 4, 5。 次の両方に該当する場合、"針" と "スケール" の値はサポートされません。 - Show の値が "Value arc" の dashboard widget field オブジェクトが設定されていない; - Show arc 詳細設定 パラメータが "Disabled" に設定されている。 Show オプションの 詳細設定 パラメータは、該当する値を持つ dashboard widget field オブジェクトが設定されていない場合はサポートされません。 |
|
| Override host | 1 | override_hostid._reference | ABCDE._hostid - 互換ウィジェット（Reference パラメータを "ABCDE" に設定したもの）をホストのデータソースとして設定します;DASHBOARD._hostid - ダッシュボードの Host セレクター をホストのデータソースとして設定します。このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
高度な設定
Gaugeウィジェットでは、次の高度な設定パラメータがサポートされています。
Thresholdsプロパティ名の番号（例: thresholds.0.color）は、昇順に並べたリスト内のしきい値の位置を参照します。
ただし、しきい値が異なる順序で設定されている場合、ZabbixのWebインターフェースでウィジェット設定を更新した後、値は昇順に並べ替えられます
（例: "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"、"thresholds.1.threshold":"1" → "thresholds.1.threshold": "5"）。
| パラメータ | type | name | value |
|---|---|---|---|
| Angle | 0 | angle | 指定可能な値: 180 (デフォルト) または270。 |
| Description | |||
| Description | 1 | description | マクロを含む任意の文字列値。 サポートされるマクロ: {HOST.*}、{ITEM.*}、{INVENTORY.*}、ユーザーマクロ。 デフォルト: {ITEM.NAME}。 |
| Size | 0 | desc_size | 1から100までの値を指定できます。 デフォルト: 15。 |
| Vertical position | 0 | desc_v_pos | 0 - 上; 1 - (デフォルト) 下。 |
| Bold | 0 | desc_bold | 0 - (デフォルト) 無効; 1 - 有効。 |
| Color | 1 | desc_color | 16進数のカラーコード（例: FF0000）。デフォルト: ""（空）。 |
| Value | |||
| Decimal places | 0 | decimal_places | 1から10までの値を指定できます。 デフォルト: 2。 |
| Size | 0 | value_size | 1から100までの値を指定できます。 デフォルト: 25。 |
| Bold | 0 | value_bold | 0 - (デフォルト) 無効; 1 - 有効。 |
| Color | 1 | value_color | 16進数のカラーコード（例: FF0000）。デフォルト: ""（空）。 |
| Units | |||
| Units (checkbox) | 0 | units_show | 0 - 無効; 1 - (デフォルト) 有効。 |
| Units (value) | 1 | units | 任意の文字列値。 パラメータの動作: - Units (checkbox)が「有効」に設定されている場合にサポート |
| Size | 0 | units_size | 1から100までの値を指定できます。 デフォルト: 25。 パラメータの動作: - Units (checkbox)が「有効」に設定されている場合にサポート |
| Bold | 0 | units_bold | 0 - (デフォルト) 無効; 1 - 有効。 パラメータの動作: - Units (checkbox)が「有効」に設定されている場合にサポート |
| Position | 0 | units_pos | 0 - 値の前; 1 - 値の上; 2 - (デフォルト) 値の後; 3 - 値の下。 パラメータの動作: - Units (checkbox)が「有効」に設定されている場合にサポート 次の時間関連の単位のいずれかに設定されている場合、このパラメータは無視されます: unixtime、uptime、s。 |
| Color | 1 | units_color | 16進数のカラーコード（例: FF0000）。デフォルト: ""（空）。 |
| Value arc | |||
| Arc size | 0 | value_arc_size | 1から100までの値を指定できます。 デフォルト: 20。 |
| Needle | |||
| Color | 1 | needle_color | 16進数のカラーコード（例: FF0000）。デフォルト: ""（空）。パラメータの動作: - Showの値が「Value arc」に設定されているダッシュボードウィジェットフィールドオブジェクト、またはShow arcが「有効」に設定されている場合にサポート |
| Scale | |||
| Show units | 0 | scale_show_units | 0 - 無効; 1 - (デフォルト) 有効。 パラメータの動作: - Units (checkbox)が「有効」に設定され、かつShowの値が「Value arc」に設定されているダッシュボードウィジェットフィールドオブジェクト、またはShow arcが「有効」に設定されている場合にサポート |
| Size | 0 | scale_size | 1から100までの値を指定できます。 デフォルト: 15。 パラメータの動作: - Showの値が「Value arc」に設定されているダッシュボードウィジェットフィールドオブジェクト、またはShow arcが「有効」に設定されている場合にサポート |
| Decimal places | 0 | scale_decimal_places | 1から10までの値を指定できます。 デフォルト: 0。 パラメータの動作: - Showの値が「Value arc」に設定されているダッシュボードウィジェットフィールドオブジェクト、またはShow arcが「有効」に設定されている場合にサポート |
| Thresholds | |||
| Color | 1 | thresholds.0.color | 16進数のカラーコード（例: FF0000）。 |
| Threshold | 1 | thresholds.0.threshold | 任意の数値。 サフィックス（例: 「1d」、「2w」、「4K」、「8G」）がサポートされています。 |
| Show labels | 0 | th_show_labels | 0 - (デフォルト) 無効; 1 - 有効。 パラメータの動作: - Thresholdsが設定され、かつShowの値が「Value arc」に設定されているダッシュボードウィジェットフィールドオブジェクト、またはShow arcが「有効」に設定されている場合にサポート |
| Show arc | 0 | th_show_arc | 0 - (デフォルト) 無効; 1 - 有効。 パラメータの動作: - Thresholdsが設定されている場合にサポート |
| Arc size | 0 | th_arc_size | 1から100までの値を指定できます。 デフォルト: 5。 パラメータの動作: - Show arcが「有効」に設定されている場合にサポート |
例
次の例は、ゲージウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、dashboard.createを参照してください。
ゲージウィジェットの設定
アイテム"44474" (インターフェース enp0s3: 送信ビット数)の値を表示するゲージウィジェットを設定します。 さらに、しきい値などの複数の詳細オプションを使用して、ウィジェットを視覚的に微調整します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "gauge",
"name": "Gauge",
"x": 0,
"y": 0,
"width": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid.0",
"value": 44474
},
{
"type": 1,
"name": "min",
"value": "100000"
},
{
"type": 1,
"name": "max",
"value": "1000000"
},
{
"type": 0,
"name": "show.0",
"value": 1
},
{
"type": 0,
"name": "show.1",
"value": 2
},
{
"type": 0,
"name": "show.2",
"value": 3
},
{
"type": 0,
"name": "show.4",
"value": 4
},
{
"type": 0,
"name": "show.5",
"value": 5
},
{
"type": 0,
"name": "angle",
"value": 270
},
{
"type": 0,
"name": "desc_size",
"value": 10
},
{
"type": 0,
"name": "desc_bold",
"value": 1
},
{
"type": 0,
"name": "decimal_places",
"value": 0
},
{
"type": 0,
"name": "value_bold",
"value": 1
},
{
"type": 0,
"name": "units_size",
"value": 15
},
{
"type": 0,
"name": "units_pos",
"value": 3
},
{
"type": 1,
"name": "needle_color",
"value": "3C3C3C"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "FF465C"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "700000"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "FFD54F"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "500000"
},
{
"type": 1,
"name": "thresholds.2.color",
"value": "0EC9AC"
},
{
"type": 1,
"name": "thresholds.2.threshold",
"value": "100000"
},
{
"type": 0,
"name": "th_show_labels",
"value": 1
},
{
"type": 0,
"name": "th_show_arc",
"value": 1
},
{
"type": 0,
"name": "th_arc_size",
"value": 15
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}