25 散布図
説明
これらのパラメータと、それぞれのダッシュボードウィジェットフィールドオブジェクトの可能なプロパティ値により、dashboard.createおよびdashboard.updateメソッドで散布図ウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新するリスクも生じます。 散布図ウィジェットの作成または更新を確実に行うには、以下の表に示すパラメータの動作を参照してください。
パラメーター
散布図ウィジェットでサポートされているパラメーターは以下の通りです。
| パラメーター | type | name | 値 |
|---|---|---|---|
| リフレッシュ間隔 | 0 | rf_rate | 0 - リフレッシュなし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
| 参照 | 1 | reference | 5文字からなる任意の文字列値（例：ABCDEまたはJBPNL）。この値は、ウィジェットが属するダッシュボード内で一意でなければなりません。パラメーターの動作: - 必須 |
データセット
データセットの設定には、以下のパラメータがサポートされています。
プロパティ名の最初の数字（例: ds.0.hosts.0, ds.0.items.0）は特定のデータセットを表し、2つ目の数字がある場合は設定されたホストまたはアイテムを表します。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| データセットタイプ | 0 | ds.0.dataset_type | 0 - アイテムリスト; 1 - (デフォルト) アイテムパターン。 |
|
| データセット: アイテムリスト | ||||
| 色 | 1 | ds.0.color.0 | 16進数のカラーコード（例: FF0000）。パラメータの動作: - データセットタイプが「アイテムリスト」に設定されている場合は必須 |
|
| X軸 | 4 | ds.0.x_axis_itemids.0 | アイテムID。 テンプレートダッシュボードでウィジェットを設定する場合、テンプレートで設定されたアイテムのみを設定する必要があります。 注: 複数のアイテムを設定するには、プロパティ名の数字を増やして各アイテムごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 パラメータの動作: - データセットタイプが「アイテムリスト」に設定され、X軸（ウィジェット）が設定されていない場合は必須 |
|
| X軸（ウィジェット） | 1 | ds.0.x_axis_itemids.0._reference | アイテムIDの代わりに:ABCDE._itemid - 互換性のあるウィジェット（参照パラメータを"ABCDE"に設定）をアイテムのデータソースとして設定します。注: 複数のウィジェットを設定するには、プロパティ名の数字を増やして各ウィジェットごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 パラメータの動作: - データセットタイプが「アイテムリスト」に設定され、X軸が設定されていない場合は必須 |
|
| Y軸 | 4 | ds.0.y_axis_itemids.0 | アイテムID。 テンプレートダッシュボードでウィジェットを設定する場合、テンプレートで設定されたアイテムのみを設定する必要があります。 注: 複数のアイテムを設定するには、プロパティ名の数字を増やして各アイテムごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 パラメータの動作: - データセットタイプが「アイテムリスト」に設定され、Y軸（ウィジェット）が設定されていない場合は必須 |
|
| Y軸（ウィジェット） | 1 | ds.0.y_axis_itemids.0._reference | アイテムIDの代わりに:ABCDE._itemid - 互換性のあるウィジェット（参照パラメータを"ABCDE"に設定）をアイテムのデータソースとして設定します。注: 複数のウィジェットを設定するには、プロパティ名の数字を増やして各ウィジェットごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 パラメータの動作: - データセットタイプが「アイテムリスト」に設定され、Y軸が設定されていない場合は必須 |
|
| ホストの上書き | 1 | ds.0.override_hostid._reference | ABCDE._hostid- 互換性のあるウィジェット（"参照"パラメータを"ABCDE"に設定）をホストのデータソースとして設定;DASHBOARD._hostid - ダッシュボードのホストセレクタをホストのデータソースとして設定。テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| データセット: アイテムパターン | ||||
| 色 | 1 | ds.0.color | 16進数のカラーコード（例: FF0000）。パラメータの動作: - データセットタイプが「アイテムパターン」に設定され、カラーパレットが設定されていない場合はサポート |
|
| カラーパレット | 0 | ds.0.color_palette | カラーパレットのインデックス。 有効な値の範囲: 0-11。 デフォルト: 0。 パラメータの動作: - データセットタイプが「アイテムパターン」に設定され、色が設定されていない場合はサポート |
|
| ホストパターン | 1 | ds.0.hosts.0 | ホスト名またはパターン（例: "Zabbix*"）。 パラメータの動作: - データセットタイプが「アイテムパターン」に設定されている場合は必須 テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| X軸アイテムパターン | 1 | ds.0.x_axis_items.0 | アイテム名またはパターン（例: "*: Number of processed *values per second"）。 テンプレートダッシュボードでウィジェットを設定する場合、テンプレートで設定されたアイテムのパターンのみを設定する必要があります。 パラメータの動作: - データセットタイプが「アイテムパターン」に設定されている場合は必須 |
|
| Y軸アイテムパターン | 1 | ds.0.y_axis_items.0 | アイテム名またはパターン（例: "*: Number of processed *values per second"）。 テンプレートダッシュボードでウィジェットを設定する場合、テンプレートで設定されたアイテムのパターンのみを設定する必要があります。 パラメータの動作: - データセットタイプが「アイテムパターン」に設定されている場合は必須 |
|
| ホストグループ | 2 | groupids.0 | ホストグループID。 注: 複数のホストグループを設定するには、プロパティ名の数字を増やして各ホストグループごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| ホストグループ（ウィジェット） | 1 | groupids._reference | ホストグループIDの代わりに:ABCDE._hostgroupids - 互換性のあるウィジェット（参照パラメータを"ABCDE"に設定）をホストグループのデータソースとして設定します。テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| ホストの上書き | 1 | ds.0.override_hostid._reference | ABCDE._hostid- 互換性のあるウィジェット（"参照"パラメータを"ABCDE"に設定）をホストのデータソースとして設定;DASHBOARD._hostid - ダッシュボードのホストセレクタをホストのデータソースとして設定。テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| ホストタグ | ||||
| 評価タイプ | 0 | evaltype_host | 0 - (デフォルト) And/Or; 2 - Or。 テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| タグ名 | 1 | host_tags.0.tag | 任意の文字列値。 注: プロパティ名の数字はタグ評価リスト内のタグの順序を参照します。 パラメータの動作: - ホストタグを設定する場合は必須 テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| 演算子 | 0 | host_tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。 注: プロパティ名の数字はタグ評価リスト内のタグの順序を参照します。 パラメータの動作: - ホストタグを設定する場合は必須 テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| タグ値 | 1 | host_tags.0.value | 任意の文字列値。 注: プロパティ名の数字はタグ評価リスト内のタグの順序を参照します。 パラメータの動作: - ホストタグを設定する場合は必須 テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| マーカー | 0 | ds.0.marker | 0 - (デフォルト) 楕円; 1 - 四角; 2 - 三角; 3 - ひし形; 4 - 星; 5 - 十字。 |
|
| マーカーサイズ | 0 | ds.0.marker_size | 0 - (デフォルト) 小（6px）; 1 - 中（9px）; 2 - 大（15px）。 |
|
| タイムシフト | 1 | ds.0.timeshift | 有効な時間文字列（例: 3600, 1hなど）。時間のサフィックスを使用できます。負の値も許可されます。 デフォルト: ""（空）。 |
|
| 集約間隔 | 1 | ds.0.aggregate_interval | 有効な時間文字列（例: 3600, 1hなど）。時間のサフィックスを使用できます。 デフォルト: 15m。 |
|
| 集約関数 | 0 | ds.0.aggregate_function | 0 - 使用しない; 1 - min; 2 - max; 3 - (デフォルト) avg; 4 - count; 5 - sum; 6 - first; 7 - last。 |
|
表示オプション
表示オプションの設定には、以下のパラメータがサポートされています。
| パラメータ | タイプ | 名前 | 値 |
|---|---|---|---|
| 履歴データの選択 | 0 | source | 0 - (デフォルト) 自動; 1 - 履歴; 2 - トレンド。 |
期間
期間の設定には、以下のパラメータがサポートされています。
| パラメータ | type | name | 値 | |
|---|---|---|---|---|
| 期間 | 1 | time_period._reference | DASHBOARD._timeperiod - ダッシュボードの期間セレクタをデータソースとして設定します。ABCDE._timeperiod - 互換性のあるウィジェット（参照パラメータが"ABCDE"に設定されているもの）をデータソースとして設定します。デフォルト: DASHBOARD._timeperiodまたは、FromおよびToパラメータで期間のみを設定することもできます。 |
|
| From | 1 | time_period.from | 絶対（YYYY-MM-DD hh:mm:ss）または相対時間構文（now、now/d、now/w-1wなど）の有効な時間文字列。パラメータの動作: - 期間が設定されていない場合にサポート |
|
| To | 1 | time_period.to | 絶対（YYYY-MM-DD hh:mm:ss）または相対時間構文（now、now/d、now/w-1wなど）の有効な時間文字列。パラメータの動作: - 期間が設定されていない場合にサポート |
|
軸
軸の設定には、以下のパラメータがサポートされています。
| パラメータ | タイプ | 名前 | 値 |
|---|---|---|---|
| X軸 | 0 | x_axis | 0 - 無効; 1 - (デフォルト) 有効。 |
| Y軸 | 0 | y_axis | 0 - (デフォルト) 無効; 1 - 有効。 |
| 最小 | 1 | x_axis_min | 任意の数値。 デフォルト: "" (空)。 |
| y_axis_min | |||
| 最大 | 1 | x_axis_max | 任意の数値。 デフォルト: "" (空)。 |
| y_axis_max | |||
| 単位 (タイプ) | 0 | x_axis_units | 0 - (デフォルト) 自動; 1 - 静的。 |
| y_axis_units | |||
| 単位 (値) | 1 | x_axis_static_units | 任意の文字列。 デフォルト: "" (空)。 |
| y_axis_static_units |
凡例
凡例の設定には、以下のパラメータがサポートされています。
| パラメータ | type | name | 値 |
|---|---|---|---|
| 凡例を表示 | 0 | legend | 0 - 無効; 1 - (デフォルト) 有効。 |
| 集約関数を表示 | 0 | legend_aggregation | 0 - (デフォルト) 無効; 1 - 有効。 パラメータの動作: - 凡例を表示が「有効」に設定されている場合にサポート |
| 行数 | 0 | legend_lines_mode | 0 - (デフォルト) 固定; 1 - 可変。 パラメータの動作: - 凡例を表示が「有効」に設定されている場合にサポート |
| 行数/ 最大行数 |
0 | legend_lines | 可能な値の範囲: 1-10。 デフォルト: 1。 パラメータの動作: - 凡例を表示が「有効」に設定されている場合にサポート |
| 列数 | 0 | legend_columns | 可能な値の範囲: 1-4。 デフォルト: 4。 パラメータの動作: - 凡例を表示が「有効」に設定されている場合にサポート |
閾値
閾値の設定には、以下のパラメータがサポートされています。
閾値プロパティ名の数字（例: thresholds.0.color）は、昇順にソートされたリスト内の閾値の位置を参照します。 ただし、閾値が異なる順序で設定されている場合、Zabbixフロントエンドでウィジェット設定を更新した後に値が昇順にソートされます （例: "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5"）。
| パラメータ | 型 | 名前 | 値 |
|---|---|---|---|
| 色の補間 | 0 | interpolation | 0 - (デフォルト) 無効; 1 - 有効。 |
| 色 | 1 | thresholds.0.color | 16進数のカラーコード（例: FF0000）。 |
| X軸 | 1 | thresholds.0.x_axis_threshold | 任意の数値。サフィックス（例: "1d", "2w", "4K", "8G"）がサポートされています。 |
| Y軸 | 1 | thresholds.0.y_axis_threshold | 任意の数値。サフィックス（例: "1d", "2w", "4K", "8G"）がサポートされています。 |
例
次の例は、散布図ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定のみを説明することを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
散布図ウィジェットの設定
散布図ウィジェットは、以下のように設定します。
- データセットタイプ「アイテムパターン」のデータセットを5つ、それぞれデフォルトの集計(平均、15分)と異なるマーカーで設定
- 凡例は、設定したアイテムを1行2列で表示
- しきい値を設定し、いずれかの軸で値が80に達した場合にマーカーを赤色で表示
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "scatterplot",
"name": "Scatter plot",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "ds.0.color",
"value": "0C5A87"
},
{
"type": 1,
"name": "ds.0.hosts.0",
"value": "de-frankfurt*"
},
{
"type": 1,
"name": "ds.0.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.0.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.0.marker",
"value": 0
},
{
"type": 0,
"name": "ds.0.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.1.color",
"value": "66B0D9"
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "fr-paris*"
},
{
"type": 1,
"name": "ds.1.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.1.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.1.marker",
"value": 1
},
{
"type": 0,
"name": "ds.1.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.2.color",
"value": "0A466A"
},
{
"type": 1,
"name": "ds.2.hosts.0",
"value": "lv-riga*"
},
{
"type": 1,
"name": "ds.2.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.2.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.2.marker",
"value": 2
},
{
"type": 0,
"name": "ds.2.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.3.color",
"value": "3394C3"
},
{
"type": 1,
"name": "ds.3.hosts.0",
"value": "pl-warsaw*"
},
{
"type": 1,
"name": "ds.3.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.3.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.3.marker",
"value": 3
},
{
"type": 0,
"name": "ds.3.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.4.color",
"value": "1492C8"
},
{
"type": 1,
"name": "ds.4.hosts.0",
"value": "se-stockholm*"
},
{
"type": 1,
"name": "ds.4.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.4.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.4.marker",
"value": 4
},
{
"type": 0,
"name": "ds.4.marker_size",
"value": 1
},
{
"type": 0,
"name": "legend_columns",
"value": 2
},
{
"type": 0,
"name": "interpolation",
"value": 1
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "D40000"
},
{
"type": 1,
"name": "thresholds.0.x_axis_threshold",
"value": "80"
},
{
"type": 1,
"name": "thresholds.0.y_axis_threshold",
"value": ""
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "D40000"
},
{
"type": 1,
"name": "thresholds.1.x_axis_threshold",
"value": ""
},
{
"type": 1,
"name": "thresholds.1.y_axis_threshold",
"value": "80"
},
{
"type": 1,
"name": "reference",
"value": "JQISY"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: