Documentation
12 蜂窝结构
描述
这些参数以及相应仪表板 widget 字段的可能属性值 objects 可用于配置 Honeycomb widget 在 dashboard.create 和 dashboard.update 方法中。
widget fields 属性在仪表板创建或 update 期间不会被验证。 这允许用户修改 built-in widgets 和 create custom widgets，但也存在创建或更新部件不正确的风险。 为确保成功创建或 update Honeycomb 部件，请参考下表中列出的参数行为。
参数
Honeycomb小组件支持以下参数。
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 无刷新； 10 - 10 秒； 30 - 30 秒； 60 - (默认) 1 分钟； 120 - 2 分钟； 600 - 10 分钟； 900 - 15 分钟。 |
|
| Host groups | 2 | groupids.0 | Host group ID。 注意：要配置多个 主机 组，需为每个 主机组 使用递增的属性名称 create 仪表板 widget 字段 object。 如果在 template dashboard 上配置 widget，则不支持此参数。 |
|
| 主机 组（小部件） | 1 | groupids._reference | 无需使用 Host group ID：ABCDE._hostgroupids - 设置一个 部件兼容性（将其 Reference 参数设置为 "ABCDE"）作为 主机 组的数据源。如果在 template dashboard 上配置小get，则不支持此参数。 |
|
| Hosts | 3 | hostids.0 | Host ID。 注意：要配置多个 主机，请 create 一个仪表板 widget 字段 object，并为每个 主机 在属性名称中使用递增的编号。 对于多个 主机，参数 主机 组 必须要么完全不配置，要么至少配置一个 主机组，且该组必须包含所配置的 主机。 如果在 template dashboard 上配置 widget，则不支持此参数。 |
|
| 主机（Widget/Dashboard） | 1 | hostids._reference | 无需使用 Host ID：DASHBOARD.hostids - 将 覆盖主机 设置为 主机 的数据源；ABCDE._hostids - 将一个 部件兼容性（将其 Reference 参数设置为 "ABCDE"）设置为 主机 的数据源。如果在 template dashboard 上配置 widget，则不支持此参数。 |
|
| Host tags | ||||
| 评估类型 | 0 | evaltype_host | 0 - (默认) And/Or; 2 - Or。 如果在template dashboard上配置widget，则不支持此参数。 |
|
| 标签名称 | 1 | host_tags.0.tag | 任意 string 值。 注意：属性名称中的数字表示标签在标签评估列表中的顺序。 参数行为: - 在配置 主机 标签 时为必填项 如果在 template dashboard 上配置 widget，则不支持此参数。 |
|
| 操作符 | 0 | host_tags.0.operator | 0 - 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在。 注意：属性名称中的数字引用标签评估列表中的标签顺序。 参数行为: - 如果配置 主机 标签 则为必填项 如果在 template dashboard 上配置 widget，则不支持此参数。 |
|
| 标签值 | 1 | host_tags.0.value | 任意 string 值。 注意：属性名称中的数字表示标签评估列表中的标签顺序。 参数行为: - 在配置 主机 标签 时为必填项 在配置 widget 于 template dashboard 上时不支持此参数。 |
|
| Item patterns | 1 | items.0 | Item 名称或模式。 注意：要配置多个 监控项 模式，每个 监控项 模式需使用属性名称中递增的编号，create 仪表板 widget 字段 object。 参数行为: - 必填 |
|
| Item tags | ||||
| 评估类型 | 0 | evaltype_item | 0 - (默认) And/Or; 2 - Or。 |
|
| 标签名称 | 1 | item_tags.0.tag | 任意 string 值。 注意：属性名称中的数字引用的是标签评估列表中的标签顺序。 参数行为: - 如果配置 监控项标签 则为必填项 |
|
| 操作符 | 0 | item_tags.0.operator | 0 - 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在。 注意：属性名称中的数字表示标签评估列表中的标签顺序。 参数行为: - 如果配置 监控项标签 则为必填项。 |
|
| 标签值 | 1 | item_tags.0.value | 任意 string 值。 注意：属性名称中的数字引用了标签评估列表中的标签顺序。 参数行为： - 如果配置 监控项标签 则为必填项 |
|
| Show hosts in maintenance | 0 | maintenance | 0 - (默认) 已禁用； 1 - 已启用。 |
|
| Show | 0 | show.0 | 1 - 主标签； 2 - 次标签。 注意：要配置多个值，请create一个仪表板小部件get字段object，并为每个值在属性名称中使用递增的数字。 默认值：1，2。 |
|
| Reference | 1 | reference | 任何由 5 个字符组成的 string 值（例如 ABCDE 或 JBPNL）。此值在该 widget 所属的仪表板内必须唯一。参数行为: - 必填 |
|
高级配置
Honeycomb 组件支持以下高级配置参数。
Thresholds 属性名称中的数字（例如 thresholds.0.color）引用的是按升序排列的阈值列表中的位置。 但如果阈值以不同顺序配置，在Zabbix前端更新组件配置后，这些值将按升序重新排序 （例如 "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"；"thresholds.1.threshold":"1" → "thresholds.1.threshold": "5"）。
| 参数 | 仪表板小部件字段 | 名称 | 取值 |
|---|---|---|---|
| Primary label | |||
| Type | 0 | primary_label_type | 0 - (默认) 文本； 1 - 数值。 |
| Text | 1 | primary_label | 任意string值，支持宏。 支持的宏：{主机.*}, {监控项.*}、{INVENTORY.*}、用户宏。 默认：{HOST.NAME} 参数行为: - 当Type设为"Text"时支持 |
| Decimal places | 0 | primary_label_decimal_places | 取值范围 0-6. 默认：2. 参数行为: - 当Type设为"Value"时支持 |
| Size (type) | 0 | primary_label_size_type | 0 - (默认) 自动； 1 - 自定义。 |
| Size | 0 | primary_label_size | 取值范围 1-100。 默认：20. 参数行为: - 当Size (类型)设为"Custom"时支持 |
| Bold | 0 | primary_label_bold | 0 - (默认) 禁用； 1 - 启用。 |
| Color | 1 | primary_label_color | 十六进制颜色代码（如 FF0000）。 默认值基于设置和User object的theme： "blue-theme"或"hc-light"主题为1F2C33； "dark-theme"或"hc-dark"主题为EEEEEE。 |
| Units (checkbox) | 0 | primary_label_units_show | 0 - 禁用； 1 - (默认) 启用。 参数行为: - 当Type设为"Value"时支持 |
| Units (value) | 1 | primary_label_units | 任意string值。 "" (空) 参数行为: - 当Type设为"Value"且Units (复选框)设为"Enabled"时支持 |
| Position | 0 | primary_label_units_pos | 0 - 数值前； 1 - (默认) 数值后。 参数行为: - 当Type设为"Value"且Units (复选框)设为"Enabled"时支持 若设为以下配置之一则忽略此参数：unixtime, uptime, s。 |
| Secondary label | |||
| Type | 0 | secondary_label_type | 0 - 文本； 1 - (默认) 数值。 |
| Text | 1 | secondary_label | 任意string值，支持宏。 支持的宏：{主机.*}, {监控项.*}、{INVENTORY.*}、用户宏。 默认：{{ITEM.LASTVALUE}.fmtnum(2)} 参数行为: - 当Type设为"Text"时支持 |
| Decimal places | 0 | secondary_label_decimal_places | 取值范围 0-6. 默认：2. 参数行为: - 当Type设为"Value"时支持 |
| Size (type) | 0 | secondary_label_size_type | 0 - (默认) 自动； 1 - 自定义。 |
| Size | 0 | secondary_label_size | 取值范围 1-100。 默认：30. 参数行为: - 当Size (类型)设为"Custom"时支持 |
| Bold | 0 | secondary_label_bold | 0 - 禁用； 1 - (默认) 启用。 |
| Color | 1 | secondary_label_color | 十六进制颜色代码（如 FF0000）。 默认值基于设置和User object的theme： "blue-theme"或"hc-light"主题为1F2C33； "dark-theme"或"hc-dark"主题为EEEEEE。 |
| Units (checkbox) | 0 | secondary_label_units_show | 0 - 禁用； 1 - (默认) 启用。 参数行为: - 当Type设为"Value"时支持 |
| Units (value) | 1 | secondary_label_units | 任意string值。 "" (空) 参数行为: - 当Type设为"Value"且Units (复选框)设为"Enabled"时支持 |
| Position | 0 | secondary_label_position | 0 - 数值前； 1 - (默认) 数值后。 参数行为: - 当Type设为"Value"且Units (复选框)设为"Enabled"时支持 若设为以下配置之一则忽略此参数：unixtime, uptime, s。 |
| Background color | |||
| Background color | 1 | bg_color | 十六进制颜色代码（如 FF0000）。 默认值基于设置和User object的theme： "blue-theme"主题为D9E7ED； "dark-theme"主题为3D5059； "hc-light"主题为AAD7E9； "hc-dark"主题为335463。 |
| Thresholds | |||
| Color interpolation | 0 | interpolation | 0 - 禁用； 1 - (默认) 启用。 |
| Color | 1 | thresholds.0.color | 十六进制颜色代码（如 FF0000）。 |
| Threshold | 1 | thresholds.0.threshold | 任意数值。支持Suffixes（如"1d"、"2w"、"4K"、"8G"）。 |
示例
以下示例仅用于描述为 Honeycomb 小部件配置仪表板 widget 字段 objects 的过程。 有关配置仪表板的更多信息，请参阅 dashboard.create。
配置 Honeycomb 小组件
配置一个显示Zabbix server进程利用率的蜂巢部件。
此外，修改蜂巢单元的主标签并通过阈值对部件进行视觉微调。
执行请求:
{
"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
}响应: