11 Honeycomb

说明

各个仪表盘组件字段对象中的这些参数和可用属性值允许在dashboard.create 和 dashboard.update 方法中配置蜂窝图组件。

在创建或更新仪表盘期间不会验证组件的 fields 属性。 这个方法允许用户修改内置组件和创建自定义组件，但也会导致存在错误创建或更新组件的风险。 为确保成功创建或更新蜂窝图组件，请参阅下表中概述的参数行为。

参数

Honeycomb 小组件支持以下参数。

Parameter type name value
刷新间隔 0 rf_rate 0 - 不刷新；
10 - 10 秒；
30 - 30 秒；
60 - (默认) 1 分钟；
120 - 2 分钟；
600 - 10 分钟；
900 - 15 分钟。
主机群组 2 groupids.0 主机群组 ID。

注意：要配置多个主机群组，请为每个主机群组创建一个 dashboard widget field 对象，并在属性名中递增编号。

如果在模板 dashboard上配置该小组件，则不支持此参数。
主机群组（Widget） 1 groupids._reference 替代 主机群组 ID：
ABCDE._hostgroupids - 将兼容小组件（其 Reference 参数设置为 "ABCDE"）设为主机群组的数据源。

如果在模板 dashboard上配置该小组件，则不支持此参数。
主机 3 hostids.0 主机 ID。

注意：要配置多个主机，请为每个主机创建一个 dashboard widget field 对象，并在属性名中递增编号。对于多个主机，参数 主机群组 必须完全不配置，或者至少配置一个所配置主机所属的主机群组。

如果在模板 dashboard上配置该小组件，则不支持此参数。
主机（Widget/Dashboard） 1 hostids._reference 替代 主机 ID：
DASHBOARD.hostids - 将主机 选择器设为主机的数据源；
ABCDE._hostids - 将兼容小组件（其 Reference 参数设置为 "ABCDE"）设为主机的数据源。

如果在模板 dashboard上配置该小组件，则不支持此参数。
主机标签
评估类型 0 evaltype_host 0 - (默认) 与/或；
2 - 或。

如果在模板 dashboard上配置该小组件，则不支持此参数。
标签名 1 host_tags.0.tag 任意字符串值。

注意：属性名中的数字表示标签评估列表中的标签顺序。

参数行为：
- 如果配置 主机标签，则为必需

如果在模板 dashboard上配置该小组件，则不支持此参数。
运算符 0 host_tags.0.operator 0 - 包含；
1 - 等于；
2 - 不包含；
3 - 不等于；
4 - 存在；
5 - 不存在。

注意：属性名中的数字表示标签评估列表中的标签顺序。

参数行为：
- 如果配置 主机标签，则为必需

如果在模板 dashboard上配置该小组件，则不支持此参数。
标签值 1 host_tags.0.value 任意字符串值。

注意：属性名中的数字表示标签评估列表中的标签顺序。

参数行为：
- 如果配置 主机标签，则为必需

如果在模板 dashboard上配置该小组件，则不支持此参数。
监控项模式 1 items.0 监控项名称或模式。

注意：要配置多个监控项模式，请为每个监控项模式创建一个 dashboard widget field 对象，并在属性名中递增编号。

参数行为：
- 必需
监控项标签
评估类型 0 evaltype_item 0 - (默认) 与/或；
2 - 或。
标签名 1 item_tags.0.tag 任意字符串值。

注意：属性名中的数字表示标签评估列表中的标签顺序。

参数行为：
- 如果配置 监控项标签，则为必需
运算符 0 item_tags.0.operator 0 - 包含；
1 - 等于；
2 - 不包含；
3 - 不等于；
4 - 存在；
5 - 不存在。

注意：属性名中的数字表示标签评估列表中的标签顺序。

参数行为：
- 如果配置 监控项标签，则为必需
标签值 1 item_tags.0.value 任意字符串值。

注意：属性名中的数字表示标签评估列表中的标签顺序。

参数行为：
- 如果配置 监控项标签，则为必需
在维护中显示主机 0 maintenance 0 - (默认) 禁用；
1 - 启用。
显示 0 show.0 1 - 主标签；
2 - 次标签。

注意：要配置多个值，请为每个值创建一个 dashboard widget field 对象，并在属性名中递增编号。

默认值：1, 2。
引用 1 reference 任意由 5 个字符组成的字符串值（例如，ABCDE 或 JBPNL）。此值在该小组件所属的 dashboard 中必须唯一。

参数行为：
- 必需

高级配置

Honeycomb 小组件支持以下高级配置参数。

Thresholds 属性名称中的数字（例如 thresholds.0.color）表示阈值在列表中的位置，列表按升序排序。 不过，如果阈值的配置顺序不同，在 Zabbix 前端更新小组件配置后，这些值将按升序排序 （例如，"thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"；"thresholds.1.threshold":"1" → "thresholds.1.threshold": "5"）。

Parameter type name value
Primary label
Type 0 primary_label_type 0 - (默认) 文本;
1 - 值。
Text 1 primary_label 任意字符串值，包括宏。
支持的宏：{HOST.*}、{ITEM.*}、{INVENTORY.*}、用户宏。

默认：{HOST.NAME}

参数行为：
- 当 Type 设置为 "Text" 时，supported
Decimal places 0 primary_label_decimal_places 可取值范围为 0-6。

默认：2。

参数行为：
- 当 Type 设置为 "Value" 时，supported
Size (type) 0 primary_label_size_type 0 - (默认) 自动;
1 - 自定义。
Size 0 primary_label_size 可取值范围为 1-100。

默认：20。

参数行为：
- 当 Size (type) 设置为 "Custom" 时，supported
Bold 0 primary_label_bold 0 - (默认) 禁用;
1 - 启用。
Color 1 primary_label_color 十六进制颜色代码（例如 FF0000）。

默认：基于 Settings object 和 User object 的 theme：
在 "blue-theme" 或 "hc-light" 下为 1F2C33；
在 "dark-theme" 或 "hc-dark" 下为 EEEEEE。
Units (checkbox) 0 primary_label_units_show 0 - 禁用;
1 - (默认) 启用。

参数行为：
- 当 Type 设置为 "Value" 时，supported
Units (value) 1 primary_label_units 任意字符串值。

""（空）

参数行为：
- 当 Type 设置为 "Value" 且 Units (checkbox) 设置为 "Enabled" 时，supported
Position 0 primary_label_units_pos 0 - 在值前;
1 - (默认) 在值后。

参数行为：
- 当 Type 设置为 "Value" 且 Units (checkbox) 设置为 "Enabled" 时，supported

如果设置为以下任一 time-related units：unixtime、uptime、s，则会忽略此参数。
Secondary label
Type 0 secondary_label_type 0 - 文本;
1 - (默认) 值。
Text 1 secondary_label 任意字符串值，包括宏。
支持的宏：{HOST.*}、{ITEM.*}、{INVENTORY.*}、用户宏。

默认：{{ITEM.LASTVALUE}.fmtnum(2)}

参数行为：
- 当 Type 设置为 "Text" 时，supported
Decimal places 0 secondary_label_decimal_places 可取值范围为 0-6。

默认：2。

参数行为：
- 当 Type 设置为 "Value" 时，supported
Size (type) 0 secondary_label_size_type 0 - (默认) 自动;
1 - 自定义。
Size 0 secondary_label_size 可取值范围为 1-100。

默认：30。

参数行为：
- 当 Size (type) 设置为 "Custom" 时，supported
Bold 0 secondary_label_bold 0 - 禁用;
1 - (默认) 启用。
Color 1 secondary_label_color 十六进制颜色代码（例如 FF0000）。

默认：基于 Settings object 和 User object 的 theme：
在 "blue-theme" 或 "hc-light" 下为 1F2C33；
在 "dark-theme" 或 "hc-dark" 下为 EEEEEE。
Units (checkbox) 0 secondary_label_units_show 0 - 禁用;
1 - (默认) 启用。

参数行为：
- 当 Type 设置为 "Value" 时，supported
Units (value) 1 secondary_label_units 任意字符串值。

""（空）

参数行为：
- 当 Type 设置为 "Value" 且 Units (checkbox) 设置为 "Enabled" 时，supported
Position 0 secondary_label_position 0 - 在值前;
1 - (默认) 在值后。

参数行为：
- 当 Type 设置为 "Value" 且 Units (checkbox) 设置为 "Enabled" 时，supported

如果设置为以下任一 time-related units：unixtime、uptime、s，则会忽略此参数。
Background color
Background color 1 bg_color 十六进制颜色代码（例如 FF0000）。

默认：基于 Settings object 和 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"）。

示例

以下示例仅用于介绍如何在仪表盘组件字段对象中配置 蜂窝图 组件。 更多信息，请参考 创建仪表盘。

配置一个蜂窝图组件

配置一个蜂窝图组件，用于展示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
}

响应：

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

参考