7 仪表盘(Gauge)

7 仪表盘(Gauge)

说明

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

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

参数

仪表盘(Gauge)组件支持以下参数：

参数		类型	参数名称	参数值或参数说明
刷新频率		0	rf_rate	0 - 不刷新； 10 - 10 秒； 30 - 30 秒； 60 - (默认) 1 分钟； 120 - 2 分钟； 600 - 10 分钟； 900 - 15 分钟。
监控项		4	itemid.0	监控项 ID。参数行为： - 必需的 (如果未设置监控项 (组件))。
	监控项 (组件)	1	itemid._reference	用于替代监控项 ID： `ABCDE._itemid` - 将一个标识符参数为 `ABCDE` 的兼容性组件作为数据源。参数行为： - 必需的 (如果未设置监控项)。
最小值		1	min	任意数值。支持后缀(例如：”1d”、”2w”、”4K”、”8G”) 默认值： “0”。
最大值		1	max	任意数值。支持后缀(例如：”1d”、”2w”、”4K”、”8G”) 默认值： “100”。
值弧		1	value_arc_color	十六进制颜色代码(例如：`FF0000`)。默认值：`“”` (空)。
弧背景颜色		1	empty_color	十六进制颜色代码(例如：`FF0000`)。默认值：`“”` (空)。
背景颜色		1	bg_color	十六进制颜色代码(例如：`FF0000`)。默认值：`“”` (空)。
显示		0	show.0	1 - 说明； 2 - 值； 3 - 指针； 4 - 刻度； 5 - 值弧。注意：如果需要配置多个值，则需要给每个值创建一个仪表盘组件字段对象，参数名称 `show.0` 中的数字按照顺序进行递增。默认值： 1、2、4、5。如果以下情况同时存在，则不支持配置 “指针” 和 “刻度”: - 没有显示为 “值弧” 的仪表盘组件字段； - 显示弧高级配置参数被设置为 “禁用”。如果没有设置了相应值的显示，则不支持配置显示的高级配置参数。例如：不存在显示设置为 “值” 的仪表盘组件字段，则不支持配置显示的高级配置。
覆盖主机		1	override_hostid._reference	`ABCDE._hostid` - 将一个标识符参数为 `ABCDE` 的兼容性组件作为数据源； `DASHBOARD._hostid` - 将主机选择器作为数据源。在仪表盘模板中定义组件时，此参数不可用。

高级配置

仪表盘(Gauge) 组件支持以下高级配置参数：

参数名称阈值 (例如：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	angle	可用值: 180 (默认) 或 270。
说明
说明	1	description	任意字符串，包括宏变量。支持的宏变量如下: {HOST.}、{ITEM.}、{INVENTORY.*}、用户宏变量。默认值： {ITEM.NAME}。
大小	0	desc_size	可用值范围：1-100。默认值：15。
垂直位置	0	desc_v_pos	0 - 顶部； 1 - (默认) 底部。
粗体	0	desc_bold	0 - (默认) 禁用； 1 - 启用。
颜色	1	desc_color	十六进制颜色代码(例如：`FF0000`)。默认值：`“”` (空)。
值
小数位数	0	decimal_places	可用值范围：1-10。默认值：2。
大小	0	value_size	可用值范围：1-100。默认值：25。
粗体	0	value_bold	0 - (默认) 禁用； 1 - 启用。
颜色	1	value_color	十六进制颜色代码(例如：`FF0000`)。默认值：`“”` (空)。
单位
单位 (复选框)	0	units_show	0 - 禁用； 1 - (默认) 启用。
单位 (值)	1	units	任意字符串。参数行为： - 支持 (如果单位 (复选框) 设置为 “启用”)。
大小	0	units_size	可用值范围：1-100。默认值：25。参数行为： - 支持 (如果单位 (复选框) 设置为 “启用”)。
粗体	0	units_bold	0 - (默认) 禁用； 1 - 启用。参数行为： - 支持 (如果单位 (复选框) 设置为 “启用”)。
位置	0	units_pos	0 - 值前； 1 - 值上； 2 - (默认) 值后； 3 - 值下。参数行为： - 支持 (如果单位 (复选框) 设置为 “启用”)。当配置以下任意一个时间相关单位时，此参数会被忽略: unixtime、uptime、s。
颜色	1	units_color	十六进制颜色代码(例如：`FF0000`)。默认值：`“”` (空)。
值弧
弧大小	0	value_arc_size	可用值范围： 1-100。默认值：20。
指针
颜色	1	needle_color	十六进制颜色代码(例如：`FF0000`)。默认值：`“”` (空)。参数行为： - 支持 (如果一个仪表盘组件字段对象的显示属性设置为 “值弧” 或显示弧属性设置为 “启用”)。
刻度
显示单位	0	scale_show_units	0 - 禁用； 1 - (默认) 启用。参数行为： - 支持 (如果单位 (复选框) 设置为 “启用” 或一个仪表盘组件字段对象的显示属性设置为 “值弧” 或显示弧属性设置为 “启用”)。
大小	0	scale_size	可用值范围：1-100。默认值：15。参数行为： - 支持 (如果一个仪表盘组件字段对象的显示属性设置为 “值弧” 或显示弧属性设置为 “启用”)。
小数位数	0	scale_decimal_places	可用值范围：1-10。默认值：0。参数行为： - 支持 (如果一个仪表盘组件字段对象的显示属性设置为 “值弧” 或显示弧属性设置为 “启用”)。
阈值
颜色	1	thresholds.0.color	十六进制颜色代码(例如：`FF0000`)。
阈值	1	thresholds.0.threshold	任意数值。支持后缀(例如：”1d”、”2w”、”4K”、”8G”)。
显示标签(label)	0	th_show_labels	0 - (默认) 禁用； 1 - 启用。参数行为： - 支持 (如果设置了阈值或一个仪表盘组件字段对象的显示属性设置为 “值弧” 或显示弧属性设置为 “启用”)。
显示弧	0	th_show_arc	0 - (默认) 禁用； 1 - 启用。参数行为： - 支持 (如果设置了阈值)。
弧大小	0	th_arc_size	可用值范围： 1-100。默认值： 5. 参数行为： - 支持 (如果显示弧设置为 “启用”)。

示例

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

配置一个仪表盘(Gauge)组件

配置一个仪表盘(Gauge)组件，用于展示监控项 “44474” 上由接口 enp0s3 发送的监控项值另外，通过包含阈值在内的多个高级选项对组件进行视觉微调。

请求:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "gauge",
                               "name": "Gauge",
                               "x": 0,
                               "y": 0,
                               "width": 18,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 4,
                                       "name": "itemid.0",
                                       "value": 44474
                                   },
                                   {
                                       "type": 1,
                                       "name": "min",
                                       "value": "100000"
                                   },
                                   {
                                       "type": 1,
                                       "name": "max",
                                       "value": "1000000"
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.0",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.1",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.2",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.4",
                                       "value": 4
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.5",
                                       "value": 5
                                   },
                                   {
                                       "type": 0,
                                       "name": "angle",
                                       "value": 270
                                   },
                                   {
                                       "type": 0,
                                       "name": "desc_size",
                                       "value": 10
                                   },
                                   {
                                       "type": 0,
                                       "name": "desc_bold",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "decimal_places",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "value_bold",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "units_size",
                                       "value": 15
                                   },
                                   {
                                       "type": 0,
                                       "name": "units_pos",
                                       "value": 3
                                   },
                                   {
                                       "type": 1,
                                       "name": "needle_color",
                                       "value": "3C3C3C"
                                   },
                                   {
                                       "type": 1,
                                       "name": "thresholds.0.color",
                                       "value": "FF465C"
                                   },
                                   {
                                       "type": 1,
                                       "name": "thresholds.0.threshold",
                                       "value": "700000"
                                   },
                                   {
                                       "type": 1,
                                       "name": "thresholds.1.color",
                                       "value": "FFD54F"
                                   },
                                   {
                                       "type": 1,
                                       "name": "thresholds.1.threshold",
                                       "value": "500000"
                                   },
                                   {
                                       "type": 1,
                                       "name": "thresholds.2.color",
                                       "value": "0EC9AC"
                                   },
                                   {
                                       "type": 1,
                                       "name": "thresholds.2.threshold",
                                       "value": "100000"
                                   },
                                   {
                                       "type": 0,
                                       "name": "th_show_labels",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "th_show_arc",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "th_arc_size",
                                       "value": 15
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

响应：

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