Documentation
7 仪表盘
描述
这些参数以及相应仪表板 widget 字段的可能属性值 objects 允许在 dashboard.create 和 dashboard.update 方法中配置 Gauge widget。
在仪表板创建或 update 过程中，不会验证 widget fields 属性。
这允许用户修改 built-in widgets 和 create custom widgets，但也带来了创建或更新部件时出错的风险。
为确保成功创建或 update Gauge 部件，请参考下表中列出的参数行为。
参数
以下参数受Gauge小部件支持。
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 无刷新; 10 - 10 秒; 30 - 30 秒; 60 - (默认) 1 分钟; 120 - 2 分钟; 600 - 10 分钟; 900 - 15 分钟。 |
|
| Item | 4 | itemid.0 | Item ID. 参数行为: - 必填 若 监控项（小部件） 未设置 |
|
| 监控项（小部件） | 1 | itemid._reference | 无需使用Item ID：ABCDE._itemid - 将一个部件兼容性（将其Reference参数设置为"ABCDE"）设置为监控项的数据源。参数行为： - 如果未设置监控项，则为必填 |
|
| Min | 1 | min | 支持任何数值。Suffixes（例如 "1d", "2w", "4K", "8G"）。默认值为 "0"。 | |
| Max | 1 | max | 支持任何数值。Suffixes（例如 "1d", "2w", "4K", "8G"）。 默认值："100"。 |
|
| Value arc | 1 | value_arc_color | 十六进制颜色代码（例如：FF0000）。默认值： ""（空）。 |
|
| Arc background | 1 | empty_color | 十六进制颜色代码（例如 FF0000）。默认值： ""（空）。 |
|
| Background | 1 | bg_color | 十六进制颜色代码（例如：FF0000）。默认值： ""（空）。 |
|
| Show | 0 | show.0 | 1 - 描述； 2 - 值； 3 - 指针； 4 - 刻度； 5 - 值弧。 注意：要配置多个值，请为每个值使用递增的属性名，create 仪表盘 widget 字段 object。 默认值：1、2、4、5。 如果同时满足以下条件，则不支持“指针”和“刻度”值： - 未设置用于 显示 的仪表盘 widget 字段 object，其值为“值弧”； - 显示弧 高级配置 参数设置为“禁用”。 如果未设置具有相应值的仪表盘 widget 字段 objects，则不支持用于 显示 选项的 高级配置 参数。 |
|
| Override host | 1 | override_hostid._reference | ABCDE._hostid - 将一个 部件兼容性（将其 Reference 参数设置为 "ABCDE"）设置为 主机 的数据源；DASHBOARD._hostid - 将仪表板 覆盖主机 设置为 主机 的数据源。如果在 template dashboard 上配置 widget，则不支持此参数。 |
|
高级配置
Gauge 小组件支持以下高级配置参数。
Thresholds 属性名称中的数字（例如 thresholds.0.color）表示该阈值在列表中的位置，按升序排列。 但是，如果以不同的顺序配置了阈值，在 Zabbix 前端更新 widget 配置后，这些值将按升序重新排序。 （例如 "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"； "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5"）。
| 参数 | 仪表板小部件字段 | 名称 | 值 |
|---|---|---|---|
| Angle | 0 | angle | 可选值：180 （默认） 或 270。 |
| Description | |||
| Description | 1 | description | 任意 string 值，包括宏。 支持的宏：{主机.*}, {监控项.*}, {INVENTORY.*}, 用户宏。 默认值：{ITEM.NAME}。 |
| Size | 0 | desc_size | 可选值范围为 1-100。 默认值：15。 |
| Vertical position | 0 | desc_v_pos | 0 - Top； 1 - （默认） 底部。 |
| Bold | 0 | desc_bold | 0 - （默认） 禁用； 1 - 启用。 |
| Color | 1 | desc_color | 十六进制颜色代码（例如 FF0000）。默认值： ""（空）。 |
| Value | |||
| Decimal places | 0 | decimal_places | 可选值范围为 1-10。 默认值：2。 |
| Size | 0 | value_size | 可选值范围为 1-100。 默认值：25。 |
| Bold | 0 | value_bold | 0 - （默认） 禁用； 1 - 启用。 |
| Color | 1 | value_color | 十六进制颜色代码（例如 FF0000）。默认值： ""（空）。 |
| Units | |||
| Units (checkbox) | 0 | units_show | 0 - 禁用； 1 - （默认） 启用。 |
| Units (value) | 1 | units | 任意 string 值。 参数行为： - 如果 Units（复选框）设置为“启用”，则支持 |
| Size | 0 | units_size | 可选值范围为 1-100。 默认值：25。 参数行为： - 如果 Units（复选框）设置为“启用”，则支持 |
| Bold | 0 | units_bold | 0 - （默认） 禁用； 1 - 启用。 参数行为： - 如果 Units（复选框）设置为“启用”，则支持 |
| Position | 0 | units_pos | 0 - 值之前； 1 - 值之上； 2 - （默认） 值之后； 3 - 值之下。 参数行为： - 如果 Units（复选框）设置为“启用”，则支持 如果设置为以下 配置 之一：unixtime、uptime、s，则忽略此参数。 |
| Color | 1 | units_color | 十六进制颜色代码（例如 FF0000）。默认值： ""（空）。 |
| Value arc | |||
| Arc size | 0 | value_arc_size | 可选值范围为 1-100。 默认值：20。 |
| Needle | |||
| Color | 1 | needle_color | 十六进制颜色代码（例如 FF0000）。默认值： ""（空）。参数行为： - 如果仪表板 widget 字段 object 设置了 Show 值为“Value arc”，或 Show arc 设置为“启用”，则支持 |
| Scale | |||
| Show units | 0 | scale_show_units | 0 - 禁用； 1 - （默认） 启用。 参数行为： - 如果 Units（复选框）设置为“启用”，并且仪表板 widget 字段 object 设置了 Show 值为“Value arc”，或 Show arc 设置为“启用”，则支持 |
| Size | 0 | scale_size | 可选值范围为 1-100。 默认值：15。 参数行为： - 如果仪表板 widget 字段 object 设置了 Show 值为“Value arc”，或 Show arc 设置为“启用”，则支持 |
| Decimal places | 0 | scale_decimal_places | 可选值范围为 1-10。 默认值：0。 参数行为： - 如果仪表板 widget 字段 object 设置了 Show 值为“Value arc”，或 Show arc 设置为“启用”，则支持 |
| Thresholds | |||
| Color | 1 | thresholds.0.color | 十六进制颜色代码（例如 FF0000）。 |
| Threshold | 1 | thresholds.0.threshold | 任意数值。支持 Suffixes（例如 "1d", "2w", "4K", "8G"）。 |
| Show labels | 0 | th_show_labels | 0 - （默认） 禁用； 1 - 启用。 参数行为： - 如果设置了 Thresholds，并且仪表板 widget 字段 object 设置了 Show 值为“Value arc”，或 Show arc 设置为“启用”，则支持 |
| Show arc | 0 | th_show_arc | 0 - （默认） 禁用； 1 - 启用。 参数行为： - 如果设置了 Thresholds，则支持 |
| Arc size | 0 | th_arc_size | 可选值范围为 1-100。 默认值：5。 参数行为： - 如果 Show arc 设置为“启用”，则支持 |
示例
以下示例仅用于描述仪表盘中 Gauge 小部件的 widget 字段 objects 的配置。 有关配置仪表盘的更多信息，请参见 dashboard.create。
配置 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
}响应：