Documentation
Table of Contents
21 Top hosts
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、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分 |
|
| ホストグループ | 2 | groupids | ホストグループ ID 注: 複数のホストグループを設定するには、ホストグループごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
|
| ホスト | 3 | hostids | ホスト ID 注: 複数のホストを設定するには、ホストごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。複数のホストの場合、パラメータ ホストグループ はまったく設定しないか、設定されたホストが属するホストグループを少なくとも 1 つ設定する必要があります。 |
|
| ホストタグ (プロパティ名内の数字 (例: tags.tag.0) は、タグ評価リスト内のタグの順序を示します) | ||||
| 評価タイプ | 0 | evaltype | 0 - (デフォルト) および/または; 2 - または |
|
| タグ名 | 1 | tags.tag.0 | 任意の文字列値 タグを設定する場合は、パラメータタグ名が必要です。 |
|
| 演算子 | 0 | tags.operator.0 | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない タグを設定する場合は、パラメータ演算子が必要です。 |
|
| タグ値 | 1 | tags.value.0 | 任意の文字列値 タグを設定する場合は、パラメータタグ値が必要です。 |
|
| 列（下記参照） | ||||
| 順序 | 0 | 順序 | 2 - (デフォルト) 上位N件; 3 - 下位N件 |
|
| 順序列 | 0 | 列 | 設定された列の数値 | |
| ホスト数 | 0 | 数 | 有効な値の範囲は1～100です。 デフォルト: 10 |
|
列
列には、データパラメーターの設定に応じて、共通パラメーターと追加パラメーターがあります。
列に関連するすべてのパラメーターにおいて、プロパティ名に含まれる番号(例: columns.name.0)は、パラメーターが設定されている列を参照します。
以下のパラメータはすべての列でサポートされています。
| パラメータ | type | name | value |
|---|---|---|---|
| 名前 | 1 | columns.name.0 | 任意の文字列値 |
| データ (必須) |
0 | columns.data.0 | 1 - 項目値; 2 - ホスト名; 3 - テキスト |
| ベースカラー (必須) |
1 | columns.base_color.0 | 16進数カラーコード(例: FF0000) |
項目値
Data が"項目値"に設定されている場合、以下のパラメータがサポートされます。
Thresholds プロパティ名の最初の数字（例：columnsthresholds.color.0.0）は、しきい値が設定されている列を参照し、2番目の数字はリスト内のしきい値の順序（昇順）を参照します。 ただし、しきい値が異なる順序で設定されている場合は、Zabbix フロントエンドでウィジェット設定を更新すると、値は昇順で並べ替えられます。 （例："threshold.threshold.0":"5" → "threshold.threshold.0":"1"; "threshold.threshold.1":"1" → "threshold.threshold.1": "5"）。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| アイテム | 1 | columns.item.0 | 有効なアイテム名 | |
| タイムシフト (必須) |
1 | columns.timeshift.0 | 有効な数値または時刻文字列値（例：3600 または 1h）時刻サフィックス を使用できます。負の値も使用できます。 |
|
| 集計関数 | 0 | columns.aggregate_function.0 | 0 - (デフォルト) なし; 1 - 最小; 2 - 最大; 3 - 平均; 4 - 個数; 5 - 合計; 6 - 最初; 7 - 最後 |
|
| 集計間隔 | 1 | columns.aggregate_interval.0 | 有効な時刻文字列（例：3600、1h など）時刻サフィックスを使用できます。 集計関数がなしに設定されている場合、パラメーター 集計間隔 は使用できません。 デフォルト: 1h |
|
| 表示 | 0 | columns.display.0 | 1 - (デフォルト) そのまま; 2 - バー; 3 - インジケーター |
|
| 最小値 | 1 | columns.min.0 | 任意の数値 パラメータ Min は、表示 が"そのまま"に設定されている場合は使用できません。 |
|
| 最大値 | 1 | columns.max.0 | 任意の数値 パラメータ Max は、表示 が"そのまま"に設定されている場合は使用できません。 |
|
| 履歴データ | 0 | columns.history.0 | 1 - (デフォルト) 自動; 2 - 履歴; 3 - トレンド |
|
| しきい値 | ||||
| Color | 1 | columnsthresholds.color.0.0 | 16進数カラーコード（例：FF0000）デフォルト： ""（空） |
|
| Threshold | 1 | columnsthresholds.threshold.0.0 | 任意の文字列値 | |
Text
データが"テキスト"に設定されている場合、以下のパラメータがサポートされます。
| パラメータ | type | 名前 | 値 |
|---|---|---|---|
| テキスト | 1 | columns.text.0 | マクロを含む任意の文字列値 サポートされているマクロ: {HOST.*}、{INVENTORY.*}。 データが"テキスト"に設定されている場合、パラメータ テキスト は必須です。 |
例
次の例は、上位ホストウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
上位ホストウィジェットの設定
ホストグループ"4"でCPU使用率上位のホストを表示する上位ホストウィジェットを構成します。 さらに、次のカスタム列を構成します: "Host name", "Utilization", "1m avg", "5m avg", "15m avg", "Processes"。
リクエスト:
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "tophosts",
"name": "Top hosts",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 4
},
{
"type": 1,
"name": "columns.name.0",
"value": ""
},
{
"type": 0,
"name": "columns.data.0",
"value": 2
},
{
"type": 1,
"name": "columns.base_color.0",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.0",
"value": ""
},
{
"type": 1,
"name": "columns.name.1",
"value": "Utilization"
},
{
"type": 0,
"name": "columns.data.1",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.1",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.timeshift.1",
"value": ""
},
{
"type": 1,
"name": "columns.item.1",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.display.1",
"value": 3
},
{
"type": 1,
"name": "columns.min.1",
"value": "0"
},
{
"type": 1,
"name": "columns.max.1",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.color.1.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.color.1.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.color.1.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.2",
"value": "90"
},
{
"type": 1,
"name": "columns.name.2",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.data.2",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.2",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.2",
"value": ""
},
{
"type": 1,
"name": "columns.item.2",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.name.3",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.data.3",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.3",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.3",
"value": ""
},
{
"type": 1,
"name": "columns.item.3",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.name.4",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.data.4",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.4",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.4",
"value": ""
},
{
"type": 1,
"name": "columns.item.4",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.name.5",
"value": "Processes"
},
{
"type": 0,
"name": "columns.data.5",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.5",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.5",
"value": ""
},
{
"type": 1,
"name": "columns.item.5",
"value": "Number of processes"
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}レスポンス: