12 蜂窝图

12 蜂窝图

说明

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

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

参数

蜂窝图组件支持以下参数：

参数		类型	参数名称	参数值或参数说明
刷新频率		0	rf_rate	0 - 不刷新； 10 - 10 秒； 30 - 30 秒； 60 - (默认) 1 分钟； 120 - 2 分钟； 600 - 10 分钟； 900 - 15 分钟。
主机组		2	groupids.0	主机组 ID。注意：如果需要配置多个主机组，则需要给每个主机组创建一个仪表盘组件字段对象，参数名称 `groupids.0` 中的数字按照顺序进行递增。在仪表盘模板上配置组件时，这个参数不受支持。
	主机组 (组件)	1	groupids._reference	用于替代主机组 ID： `ABCDE._hostgroupids` - 将一个标识符参数为 `ABCDE` 的兼容性组件作为数据源。在仪表盘模板上配置组件时，这个参数不受支持。
主机		3	hostids.0	主机 ID。注意：如果需要配置多个主机，则需要给每个主机创建一个仪表盘组件字段对象，参数名称 `hostids.0` 中的数字按照顺序进行递增。配置多个主机时，主机组必须不进行配置或配置中至少包含一个主机所属的主机组。在仪表盘模板上配置组件时，这个参数不受支持。
	主机 (组件/仪表盘)	1	hostids._reference	用于替代主机 ID： `DASHBOARD.hostids` - 设置主机选择器为数据源； `ABCDE._hostids` - 将一个标识符参数为 `ABCDE` 的兼容性组件作为数据源。在仪表盘模板上配置组件时，这个参数不受支持。
主机标签
	评估类型	0	evaltype_host	0 - (默认) And/Or； 2 - Or。在仪表盘模板上配置组件时，这个参数不受支持。
	标签名称	1	host_tags.0.tag	任意字符串。注意：参数名称 `host_tags.0.tag` 中的数字与提供的参数列表需要一致，例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。参数行为： - 必需的 (配置主机标签时)。在仪表盘模板上配置组件时，这个参数不受支持。
	操作	0	host_tags.0.operator	0 - 包含； 1 - 相等； 2 - 不包含； 3 - 不相等； 4 - 存在； 5 - 不存在。注意：参数名称 `host_tags.0.operator` 中的数字与提供的参数列表需要一致，例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。参数行为： - 必需的 (配置主机标签时)。在仪表盘模板上配置组件时，这个参数不受支持。
	标签值	1	host_tags.0.value	任意字符串。注意：参数名称 `host_tags.0.value` 中的数字与提供的参数列表需要一致，例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。参数行为： - 必需的 (配置主机标签时)。在仪表盘模板上配置组件时，这个参数不受支持。
监控项表达式		1	items.0	监控项名称或表达式。注意：如果需要配置多个监控项表达式，则需要给每个监控项表达式创建一个仪表盘组件字段对象，参数名称 `items.0` 中的数字按照顺序进行递增。参数行为： - 必需的。
监控项标签
	评估类型	0	evaltype_item	0 - (默认) And/Or； 2 - Or。
	标签名称	1	item_tags.0.tag	任意字符串。注意：参数名称 `item_tags.0.tag` 中的数字与提供的参数列表需要一致，例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。参数行为： - 必需的 (配置监控项标签时)。
	操作	0	item_tags.0.operator	0 - 包含； 1 - 相等； 2 - 不包含； 3 - 不相等； 4 - 存在； 5 - 不存在。注意：参数名称 `item_tags.0.operator` 中的数字与提供的参数列表需要一致，例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。参数行为： - 必需的 (配置监控项标签时)。
	标签值	1	item_tags.0.value	任意字符串。注意：参数名称 `item_tags.0.value` 中的数字与提供的参数列表需要一致，例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。参数行为： - 必需的 (配置监控项标签时)。
显示维护中的主机		0	maintenance	0 - (默认) 禁用； 1 - 启用。
显示		0	show.0	1 - 主要标签； 2 - 次要标签。注意：如果需要配置多个值，则需要给每个值创建一个仪表盘组件字段对象，参数名称 `show.0` 中的数字按照顺序进行递增。默认值： 1、2。
标识符		1	reference	任意 5 个英文字符组成的字符串(例如：`ABCDE` 或 `JBPNL`)。在这个组件所属的仪表盘中，这个值必须是唯一的。参数行为： - 必需的。

高级配置

蜂窝图 组件支持以下高级配置参数：

参数名称阈值 (例如：thresholds.0.color)中的数字与提供的参数列表需要一致，且升序排序。例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。如果传入的数字未按照升序排序，则 Zabbix 前端更新组件时会自动按照升序排序。 (例如："thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"； "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5")

参数	类型	参数名称	参数值或参数说明
*主要标签*
类型	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	十六进制颜色代码(例如：`FF0000`)。默认值：基于设置对象和用户对象的 `theme`: `1F2C33` (`theme` 为 “blue-theme” 或 “hc-light” 时)； `EEEEEE` (`theme` 为 “dark-theme” 或 “hc-dark” 时)。
单位 (复选框)	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	十六进制颜色代码(例如：`FF0000`)。默认值：基于设置对象和用户对象的 `theme`: `1F2C33` (`theme` 为 “blue-theme” 或 “hc-light” 时)； `EEEEEE` (`theme` 为 “dark-theme” 或 “hc-dark” 时)。
单位 (复选框)	0	secondary_label_units_show	0 - 禁用； 1 - (默认) 启用。参数行为： - 支持 (如果类型设置为 “值”)。
单位 (值)	1	secondary_label_units	任意字符串。 `“”` (空) 参数行为： - 支持 (如果类型设置为 “值” 并且单位 (复选框) 设置为 “启用”)。
位置	0	secondary_label_position	0 - 值前； 1 - (默认) 值后。参数行为： - 支持 (如果类型设置为 “值” 并且单位 (复选框) 设置为 “启用”)。当配置以下任意一个时间相关单位时，此参数会被忽略: unixtime、uptime、s。
*背景颜色*
背景颜色	1	bg_color	十六进制颜色代码(例如：`FF0000`)。默认值：基于设置对象和用户对象的 `theme`： `D9E7ED` (`theme` 为 “blue-theme” 时)； `3D5059` (`theme` 为 “dark-theme” 时)； `AAD7E9` (`theme` 为 “hc-light” 时)； `335463` (`theme` 为 “hc-dark” 时)。
阈值
颜色插值	0	interpolation	0 - 禁用； 1 - (默认) 启用。
颜色	1	thresholds.0.color	十六进制颜色代码(例如：`FF0000`)。
阈值	1	thresholds.0.threshold	任意数值。支持后缀(例如：”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
       }