このページで
11 Honeycomb
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでハニカムウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。
これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。
ハニカムウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメータ
以下のパラメータは Honeycomb ウィジェットでサポートされています。
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 更新しない; 10 - 10秒; 30 - 30秒; 60 - (default) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| Host groups | 2 | groupids.0 | ホストグループ ID。 Note: 複数のホストグループを設定するには、プロパティ名の番号を増やしながら、各ホストグループごとに dashboard widget field オブジェクトを作成します。 このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| Host groups (Widget) | 1 | groupids._reference | ホストグループ ID の代わりに:ABCDE._hostgroupids - 互換ウィジェット（Reference パラメータを "ABCDE" に設定）をホストグループのデータソースとして設定します。このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| Hosts | 3 | hostids.0 | ホスト ID。 Note: 複数のホストを設定するには、プロパティ名の番号を増やしながら、各ホストごとに dashboard widget field オブジェクトを作成します。複数のホストを設定する場合、パラメータ Host groups は未設定であるか、設定したホストが属するホストグループを少なくとも1つ含むように設定されている必要があります。 このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | ホスト ID の代わりに:DASHBOARD.hostids - Host セレクターをホストのデータソースとして設定します。ABCDE._hostids - 互換ウィジェット（Reference パラメータを "ABCDE" に設定）をホストのデータソースとして設定します。このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| Host tags | ||||
| Evaluation type | 0 | evaltype_host | 0 - (default) And/Or; 2 - Or. このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| Tag name | 1 | host_tags.0.tag | 任意の文字列値。 Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 Parameter behavior: - Host tags を設定する場合は required このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| Operator | 0 | host_tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。 Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 Parameter behavior: - Host tags を設定する場合は required このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| Tag value | 1 | host_tags.0.value | 任意の文字列値。 Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 Parameter behavior: - Host tags を設定する場合は required このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| Item patterns | 1 | items.0 | アイテムの名前またはパターン。 Note: 複数の item pattern を設定するには、プロパティ名の番号を増やしながら、各 item pattern ごとに dashboard widget field オブジェクトを作成します。 Parameter behavior: - required |
|
| Item tags | ||||
| Evaluation type | 0 | evaltype_item | 0 - (default) And/Or; 2 - Or. |
|
| Tag name | 1 | item_tags.0.tag | 任意の文字列値。 Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 Parameter behavior: - Item tags を設定する場合は required |
|
| Operator | 0 | item_tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。 Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 Parameter behavior: - Item tags を設定する場合は required |
|
| Tag value | 1 | item_tags.0.value | 任意の文字列値。 Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 Parameter behavior: - Item tags を設定する場合は required |
|
| Show hosts in maintenance | 0 | maintenance | 0 - (default) 無効; 1 - 有効。 |
|
| Show | 0 | show.0 | 1 - 主ラベル; 2 - 副ラベル。 Note: 複数の値を設定するには、プロパティ名の番号を増やしながら、各値ごとに dashboard widget field オブジェクトを作成します。 Default: 1, 2. |
|
| Reference | 1 | reference | 5文字からなる任意の文字列値（例: ABCDE または JBPNL）。この値は、ウィジェットが属するダッシュボード内で一意である必要があります。Parameter behavior: - required |
|
高度な設定
以下の高度な設定パラメータは、Honeycombウィジェットでサポートされています。
しきい値プロパティ名の番号（例: thresholds.0.color）は、昇順に並べ替えられたリスト内のしきい値の位置を参照します。
ただし、しきい値が異なる順序で設定されている場合、ZabbixのWebインターフェースでウィジェット設定を更新した後、値は昇順に並べ替えられます
（例: "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"、"thresholds.1.threshold":"1" → "thresholds.1.threshold": "5"）。
| パラメータ | type | name | value |
|---|---|---|---|
| プライマリラベル | |||
| タイプ | 0 | primary_label_type | 0 - (デフォルト) テキスト; 1 - 値。 |
| テキスト | 1 | primary_label | マクロを含む任意の文字列値。 サポートされるマクロ: {HOST.*}、{ITEM.*}、{INVENTORY.*}、ユーザーマクロ。 デフォルト: {HOST.NAME} パラメータの動作: - タイプが「テキスト」に設定されている場合にサポート |
| 小数点以下の桁数 | 0 | primary_label_decimal_places | 0から6までの値を指定できます。 デフォルト: 2。 パラメータの動作: - タイプが「値」に設定されている場合にサポート |
| サイズ（タイプ） | 0 | primary_label_size_type | 0 - (デフォルト) 自動; 1 - カスタム。 |
| サイズ | 0 | primary_label_size | 1から100までの値を指定できます。 デフォルト: 20。 パラメータの動作: - サイズ（タイプ）が「カスタム」に設定されている場合にサポート |
| 太字 | 0 | primary_label_bold | 0 - (デフォルト) 無効; 1 - 有効。 |
| 色 | 1 | primary_label_color | 16進数のカラーコード（例: FF0000）。デフォルト: SettingsオブジェクトおよびUserオブジェクトの themeに基づく:「blue-theme」または「hc-light」の場合は 1F2C33;「dark-theme」または「hc-dark」の場合は EEEEEE。 |
| 単位（チェックボックス） | 0 | primary_label_units_show | 0 - 無効; 1 - (デフォルト) 有効。 パラメータの動作: - タイプが「値」に設定されている場合にサポート |
| 単位（値） | 1 | primary_label_units | 任意の文字列値。""（空）パラメータの動作: - タイプが「値」に設定され、単位（チェックボックス）が「有効」に設定されている場合にサポート |
| 位置 | 0 | primary_label_units_pos | 0 - 値の前; 1 - (デフォルト) 値の後。 パラメータの動作: - タイプが「値」に設定され、単位（チェックボックス）が「有効」に設定されている場合にサポート このパラメータに次の時間関連の単位のいずれかが設定されている場合、このパラメータは無視されます: unixtime、uptime、s。 |
| セカンダリラベル | |||
| タイプ | 0 | secondary_label_type | 0 - テキスト; 1 - (デフォルト) 値。 |
| テキスト | 1 | secondary_label | マクロを含む任意の文字列値。 サポートされるマクロ: {HOST.*}、{ITEM.*}、{INVENTORY.*}、ユーザーマクロ。 デフォルト: {{ITEM.LASTVALUE}.fmtnum(2)} パラメータの動作: - タイプが「テキスト」に設定されている場合にサポート |
| 小数点以下の桁数 | 0 | secondary_label_decimal_places | 0から6までの値を指定できます。 デフォルト: 2。 パラメータの動作: - タイプが「値」に設定されている場合にサポート |
| サイズ（タイプ） | 0 | secondary_label_size_type | 0 - (デフォルト) 自動; 1 - カスタム。 |
| サイズ | 0 | secondary_label_size | 1から100までの値を指定できます。 デフォルト: 30。 パラメータの動作: - サイズ（タイプ）が「カスタム」に設定されている場合にサポート |
| 太字 | 0 | secondary_label_bold | 0 - 無効; 1 - (デフォルト) 有効。 |
| 色 | 1 | secondary_label_color | 16進数のカラーコード（例: FF0000）。デフォルト: SettingsオブジェクトおよびUserオブジェクトの themeに基づく:「blue-theme」または「hc-light」の場合は 1F2C33;「dark-theme」または「hc-dark」の場合は EEEEEE。 |
| 単位（チェックボックス） | 0 | secondary_label_units_show | 0 - 無効; 1 - (デフォルト) 有効。 パラメータの動作: - タイプが「値」に設定されている場合にサポート |
| 単位（値） | 1 | secondary_label_units | 任意の文字列値。""（空）パラメータの動作: - タイプが「値」に設定され、単位（チェックボックス）が「有効」に設定されている場合にサポート |
| 位置 | 0 | secondary_label_position | 0 - 値の前; 1 - (デフォルト) 値の後。 パラメータの動作: - タイプが「値」に設定され、単位（チェックボックス）が「有効」に設定されている場合にサポート このパラメータに次の時間関連の単位のいずれかが設定されている場合、このパラメータは無視されます: unixtime、uptime、s。 |
| 背景色 | |||
| 背景色 | 1 | bg_color | 16進数のカラーコード（例: FF0000）。デフォルト: SettingsオブジェクトおよびUserオブジェクトの themeに基づく:「blue-theme」の場合は D9E7ED;「dark-theme」の場合は 3D5059;「hc-light」の場合は AAD7E9;「hc-dark」の場合は 335463。 |
| しきい値 | |||
| 色の補間 | 0 | interpolation | 0 - 無効; 1 - (デフォルト) 有効。 |
| 色 | 1 | thresholds.0.color | 16進数のカラーコード（例: FF0000）。 |
| しきい値 | 1 | thresholds.0.threshold | 任意の数値。 サフィックス（例: 「1d」、「2w」、「4K」、「8G」）がサポートされています。 |
例
次の例は、ハニカムウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、dashboard.createを参照してください。
ハニカムウィジェットの設定
Zabbixサーバープロセスの使用率を表示するハニカムウィジェットを設定します。 さらに、ハニカムセルのプライマリラベルを変更し、しきい値を設定してウィジェットを視覚的に微調整します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": "30",
"auto_start": "1",
"pages": [
{
"widgets": [
{
"type": "honeycomb",
"name": "Honeycomb",
"x": "0",
"y": "0",
"width": "24",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "items.0",
"value": "Zabbix server: Utilization*"
},
{
"type": 1,
"name": "primary_label",
"value": "{ITEM.NAME}"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "0EC9AC"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "0"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "FFD54F"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "70"
},
{
"type": 1,
"name": "thresholds.2.color",
"value": "FF465C"
},
{
"type": 1,
"name": "thresholds.2.threshold",
"value": "90"
},
{
"type": 1,
"name": "reference",
"value": "KSTMQ"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}