27 上位ホスト

説明

これらのパラメータと各ダッシュボードウィジェットフィールドオブジェクトの可能なプロパティ値により、dashboard.createおよびdashboard.updateメソッドでトップホストウィジェットを設定できます。

ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時にバリデーションされません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新するリスクも生じます。 トップホストウィジェットの作成または更新を確実に行うには、以下の表に記載されているパラメータの動作を参照してください。

パラメータ

Top hostsウィジェットでは、次のパラメータがサポートされています。

パラメータ タイプ 名前 値
更新間隔 0 rf_rate 0 - 更新なし;
10 - 10秒;
30 - 30秒;
60 - (デフォルト) 1分;
120 - 2分;
600 - 10分;
900 - 15分。
ホストグループ 2 groupids.0 ホストグループ ID。

注: 複数のホストグループを設定するには、各ホストグループに対して、プロパティ名の番号を増加させたダッシュボードウィジェットフィールドオブジェクトを作成します。

テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。
ホストグループ（ウィジェット） 1 groupids._reference ホストグループ IDの代わりに指定します:
ABCDE._hostgroupids - ホストグループのデータソースとして、互換性のあるウィジェット（Referenceパラメータに"ABCDE"を設定）を指定します。

テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。
ホスト 3 hostids.0 ホスト ID。

注: 複数のホストを設定するには、各ホストに対して、プロパティ名の番号を増加させたダッシュボードウィジェットフィールドオブジェクトを作成します。複数のホストの場合、ホストグループパラメータは未設定にするか、設定したホストが所属するホストグループを少なくとも1つ設定する必要があります。

テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。
ホスト（ウィジェット/ダッシュボード） 1 hostids._reference ホスト IDの代わりに指定します:
DASHBOARD.hostids - ホストのデータソースとしてホストセレクターを指定します;
ABCDE._hostids - ホストのデータソースとして、互換性のあるウィジェット（Referenceパラメータに"ABCDE"を設定）を指定します。

テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。
ホストタグ
評価タイプ 0 evaltype 0 - (デフォルト) And/Or;
2 - Or。

テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。
タグ名 1 tags.0.tag 任意の文字列値。

注: プロパティ名の番号は、タグ評価リスト内のタグの順序を示します。

パラメータの動作:
- ホストタグを設定する場合は必須

テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。
演算子 0 tags.0.operator 0 - 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。

注: プロパティ名の番号は、タグ評価リスト内のタグの順序を示します。

パラメータの動作:
- ホストタグを設定する場合は必須

テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。
タグ値 1 tags.0.value 任意の文字列値。

注: プロパティ名の番号は、タグ評価リスト内のタグの順序を示します。

パラメータの動作:
- ホストタグを設定する場合は必須

テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。
メンテナンス中のホストを表示 0 maintenance 0 - (デフォルト) 無効;
1 - 有効。
列（下記参照）
並べ替え基準 0 column 設定した列の数値。
順序 0 order 2 - (デフォルト) 上位N件;
3 - 下位N件。
ホスト数の上限 0 show_lines 指定可能な値の範囲は1～1000です。

デフォルト: 10。

テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。

列

列には、データパラメーターの設定に応じて、共通パラメーターと追加パラメーターがあります。

列に関連するすべてのパラメーターにおいて、プロパティ名に含まれる番号(例: columns.0.name)は、パラメーターが設定されている列を参照します。

以下のパラメーターはすべての列でサポートされています。

パラメーター type name value
Name 1 columns.0.name 任意の文字列値

パラメーターの動作:
- 必須
Data 0 columns.0.data 1 - 項目値
2 - ホスト名
3 - テキスト

パラメーターの動作:
- 必須
基本色 1 columns.0.base_color 16進数カラーコード（例：FF0000）

パラメータの動作:
- 必須
アイテムの値

データに「アイテムの値」を設定した場合、次のパラメータがサポートされます。

しきい値プロパティ名の最初の番号（例: columnsthresholds.0.color.0）は、しきい値が設定されている列を参照し、2番目の番号は昇順に並べたリスト内のしきい値の位置を参照します。 ただし、しきい値が異なる順序で設定されている場合、ZabbixのWebインターフェースでウィジェット設定を更新した後、値は昇順に並べ替えられます（例: "threshold.0.threshold":"5" → "threshold.0.threshold":"1"、"threshold.1.threshold":"1" → "threshold.1.threshold": "5"）。

パラメータ タイプ 名前 値
アイテム 1 columns.0.item 有効なアイテム名。

テンプレートダッシュボードでウィジェットを設定する場合は、テンプレートに設定されているアイテムのみを設定してください。
アイテムの値の表示形式 0 columns.0.display_value_as 0 - (デフォルト) 数値;
1 - テキスト;
2 - バイナリ。
表示 0 columns.0.display 1 - (デフォルト) そのまま;
2 - バー;
3 - インジケーター;
6 - スパークライン。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定されている場合にサポート
最小 1 columns.0.min 任意の数値。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定され、表示が「バー」または「インジケーター」に設定されている場合にサポート
最大 1 columns.0.max 任意の数値。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定され、表示が「バー」または「インジケーター」に設定されている場合にサポート
小数点以下の桁数 0 columns.0.decimal_places 0から10までの値を指定できます。

デフォルト: 2。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定されている場合にサポート
スパークライン
幅 0 columns.0.sparkline.width 0から10までの値を指定できます。

デフォルト: 1。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定され、表示が「スパークライン」に設定されている場合にサポート
塗りつぶし 0 columns.0.sparkline.fill 0から10までの値を指定できます。

デフォルト: 3。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定され、表示が「スパークライン」に設定されている場合にサポート
色 1 columns.0.sparkline.color 16進数のカラーコード（例: FF0000）。

デフォルト: 42A5F5。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定され、表示が「スパークライン」に設定されている場合にサポート
期間 1 columns.0.sparkline.time_period._reference DASHBOARD._timeperiod - データソースとして期間セレクターを設定します。
ABCDE._timeperiod - 互換性のあるウィジェット（referenceパラメータがABCDEに等しいもの）をデータソースとして設定します。

デフォルト: DASHBOARD._timeperiod

または、開始および終了パラメータでのみ期間を設定できます。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定され、表示が「スパークライン」に設定されている場合にサポート
開始 1 columns.0.sparkline.time_period.from 絶対（YYYY-MM-DD hh:mm:ss）または相対時刻構文（now、now/d、now/w-1wなど）による有効な時刻文字列。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定され、表示が「スパークライン」に設定されている場合にサポート
- columns.0.sparkline.time_period.toが設定されている場合に必須
終了 1 columns.0.sparkline.time_period.to 絶対（YYYY-MM-DD hh:mm:ss）または相対時刻構文（now、now/d、now/w-1wなど）による有効な時刻文字列。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定され、表示が「スパークライン」に設定されている場合にサポート
- columns.0.sparkline.time_period.fromが設定されている場合に必須
履歴データ 0 columns.0.sparkline.history 0 - (デフォルト) 自動;
1 - 履歴;
2 - トレンド。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定され、表示が「スパークライン」に設定されている場合にサポート
しきい値
色 1 columnsthresholds.0.color.0 16進数のカラーコード（例: FF0000）。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定されている場合にサポート
しきい値 1 columnsthresholds.0.threshold.0 任意の文字列値。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定されている場合にサポート
ハイライト
色 1 columns.0.highlights.0.color 16進数のカラーコード（例: FF0000）。

パラメータの動作:
- アイテムの値の表示形式が「テキスト」に設定されている場合にサポート
パターン 1 columns.0.highlights.0.pattern 任意の文字列値。

パラメータの動作:
- アイテムの値の表示形式が「テキスト」に設定されている場合にサポート
サムネイルを表示 0 columns.0.show_thumbnail 0 - (デフォルト) 無効;
1 - 有効。

パラメータの動作:
- アイテムの値の表示形式が「バイナリ」に設定されている場合にサポート
集計関数 0 columns.0.aggregate_function 0 - (デフォルト) 使用しない;
1 - 最小値;
2 - 最大値;
3 - 平均値;
4 - 件数;
5 - 合計;
6 - 最初;
7 - 最後。
期間 1 columns.0.time_period._reference DASHBOARD._timeperiod - データソースとして期間セレクターを設定します。
ABCDE._timeperiod - 互換性のあるウィジェット（referenceパラメータがABCDEに等しいもの）をデータソースとして設定します。

デフォルト: DASHBOARD._timeperiod

または、開始および終了パラメータでのみ期間を設定できます。

パラメータの動作:
- 集計関数が「最小値」、「最大値」、「平均値」、「件数」、「合計」、「最初」、「最後」に設定されている場合にサポート
開始 1 columns.0.time_period.from 絶対（YYYY-MM-DD hh:mm:ss）または相対時刻構文（now、now/d、now/w-1wなど）による有効な時刻文字列。

パラメータの動作:
- 期間が設定されておらず、集計関数が「最小値」、「最大値」、「平均値」、「件数」、「合計」、「最初」、「最後」に設定されている場合にサポート
- columns.0.time_period.toが設定されている場合に必須
- columns.0.time_period.toが設定されている場合に必須
終了 1 columns.0.time_period.to 絶対（YYYY-MM-DD hh:mm:ss）または相対時刻構文（now、now/d、now/w-1wなど）による有効な時刻文字列。

パラメータの動作:
- 期間が設定されておらず、集計関数が「最小値」、「最大値」、「平均値」、「件数」、「合計」、「最初」、「最後」に設定されている場合にサポート
- columns.0.time_period.fromが設定されている場合に必須
履歴データ 0 columns.0.history 0 - (デフォルト) 自動;
1 - 履歴;
2 - トレンド。

パラメータの動作:
- アイテムの値の表示形式が「数値」に設定されている場合にサポート
参照 1 reference 5文字で構成される任意の文字列値（例: ABCDEまたはJBPNL）。この値は、ウィジェットが属するダッシュボード内で一意である必要があります。

パラメータの動作:
- 必須
Text

データが"テキスト"に設定されている場合、以下のパラメーターがサポートされます。

パラメーター type name value
テキスト 1 columns.0.text マクロを含む任意の文字列値
サポートされているマクロ: {HOST.*}、{INVENTORY.*}

パラメーターの動作:
- データがテキスト"に設定されている場合、必須

例

次の例は、上位ホストウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。

上位ホストウィジェットの設定

ホストグループ"4"でCPU使用率上位のホストを表示する上位ホストウィジェットを構成します。 さらに、次のカスタム列を構成します: "Host name", "CPU utilization in %", "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": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 2,
                                "name": "groupids.0",
                                "value": 4
                            },
                            {
                                "type": 1,
                                "name": "columns.0.name",
                                "value": "Host"
                            },
                            {
                                "type": 0,
                                "name": "columns.0.data",
                                "value": 2
                            },
                            {
                                "type": 1,
                                "name": "columns.0.base_color",
                                "value": "FFFFFF"
                            },
                            {
                                "type": 1,
                                "name": "columns.1.name",
                                "value": "CPU utilization in %"
                            },
                            {
                                "type": 0,
                                "name": "columns.1.data",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "columns.1.base_color",
                                "value": "4CAF50"
                            },
                            {
                                "type": 1,
                                "name": "columns.1.item",
                                "value": "CPU utilization"
                            },
                            {
                                "type": 0,
                                "name": "columns.1.display",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "columns.1.min",
                                "value": "0"
                            },
                            {
                                "type": 1,
                                "name": "columns.1.max",
                                "value": "100"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.1.color.0",
                                "value": "FFFF00"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.1.threshold.0",
                                "value": "50"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.1.color.1",
                                "value": "FF8000"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.1.threshold.1",
                                "value": "80"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.1.color.2",
                                "value": "FF4000"
                            },
                            {
                                "type": 1,
                                "name": "columnsthresholds.1.threshold.2",
                                "value": "90"
                            },
                            {
                                "type": 1,
                                "name": "columns.2.name",
                                "value": "1m avg"
                            },
                            {
                                "type": 0,
                                "name": "columns.2.data",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "columns.2.base_color",
                                "value": "FFFFFF"
                            },
                            {
                                "type": 1,
                                "name": "columns.2.item",
                                "value": "Load average (1m avg)"
                            },
                            {
                                "type": 1,
                                "name": "columns.3.name",
                                "value": "5m avg"
                            },
                            {
                                "type": 0,
                                "name": "columns.3.data",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "columns.3.base_color",
                                "value": "FFFFFF"
                            },
                            {
                                "type": 1,
                                "name": "columns.3.item",
                                "value": "Load average (5m avg)"
                            },
                            {
                                "type": 1,
                                "name": "columns.4.name",
                                "value": "15m avg"
                            },
                            {
                                "type": 0,
                                "name": "columns.4.data",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "columns.4.base_color",
                                "value": "FFFFFF"
                            },
                            {
                                "type": 1,
                                "name": "columns.4.item",
                                "value": "Load average (15m avg)"
                            },
                            {
                                "type": 1,
                                "name": "columns.5.name",
                                "value": "Processes"
                            },
                            {
                                "type": 0,
                                "name": "columns.5.data",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "columns.5.base_color",
                                "value": "FFFFFF"
                            },
                            {
                                "type": 1,
                                "name": "columns.5.item",
                                "value": "Number of processes"
                            },
                            {
                                "type": 0,
                                "name": "columns.5.decimal_places",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "column",
                                "value": 1
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

参照