6 仪表盘
描述
这些参数及对应仪表板小组件字段objects的可选属性值允许通过dashboard.create和dashboard.update方法配置Gauge小组件.
小组件fields的属性在仪表板创建或update过程中不会进行验证.
这使得用户可以修改built-in widgets和createcustom widgets,但也存在错误创建或更新小组件的风险.
为确保Gauge小组件成功创建或update,请参考下文表格中列出的参数行为规范.
参数
仪表盘小部件支持以下参数。
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| 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 - 设置一个 部件兼容性 (其参考参数设置为"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 仪表盘小部件字段 object 为每个值在属性名称中递增数字。 默认: 1, 2, 4, 5。 如果同时满足以下条件，不支持"指针"和"刻度"值: - 未设置 显示 值为"值弧"的仪表盘小部件字段 object; - 显示弧 高级配置 参数设置为"禁用"。 如果未设置具有相应值的仪表盘小部件字段 objects，则不支持 显示 选项的高级配置参数。 |
|
| Override host | 1 | override_hostid._reference | ABCDE._hostid - 设置一个 部件兼容性 (其参考参数设置为"ABCDE")作为 主机 的数据源;DASHBOARD._hostid - 设置仪表盘 覆盖主机 作为 主机 的数据源。如果在 template dashboard 上配置小部件，则不支持此参数。 |
|
高级配置
Gauge 小部件支持以下高级配置参数。
Thresholds 属性名称中的数字（例如 thresholds.0.color）引用按升序排序的阈值列表中的位置。
但是，如果阈值以不同顺序配置，在Zabbix前端更新小部件配置后，这些值将按升序重新排序
（例如 "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 值。 参数行为: - 支持 当单位（复选框）设为"启用"时 |
| Size | 0 | units_size | 可能值范围1-100。 默认：25。 参数行为: - 支持 当单位（复选框）设为"启用"时 |
| Bold | 0 | units_bold | 0 - (默认) 禁用; 1 - 启用。 参数行为: - 支持 当单位（复选框）设为"启用"时 |
| Position | 0 | units_pos | 0 - 值前; 1 - 值上; 2 - (默认) 值后; 3 - 值下。 参数行为: - 支持 当单位（复选框）设为"启用"时 当设置为以下 配置 之一时忽略此参数：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）。默认： ""（空）。参数行为: - 支持 当仪表板小部件字段 object 中显示设为"值弧"或显示弧设为"启用"时 |
| Scale | |||
| Show units | 0 | scale_show_units | 0 - 禁用; 1 - (默认) 启用。 参数行为: - 支持 当单位设为"启用"且仪表板小部件字段 object 中显示设为"值弧"或显示弧设为"启用"时 |
| Size | 0 | scale_size | 可能值范围1-100。 默认：15。 参数行为: - 支持 当仪表板小部件字段 object 中显示设为"值弧"或显示弧设为"启用"时 |
| Decimal places | 0 | scale_decimal_places | 可能值范围1-10。 默认：0。 参数行为: - 支持 当仪表板小部件字段 object 中显示设为"值弧"或显示弧设为"启用"时 |
| 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 - 启用。 参数行为: - 支持 当设置阈值且仪表板小部件字段 object 中显示设为"值弧"或显示弧设为"启用"时 |
| Show arc | 0 | th_show_arc | 0 - (默认) 禁用; 1 - 启用。 参数行为: - 支持 当设置阈值时 |
| Arc size | 0 | th_arc_size | 可能值范围1-100。 默认：5。 参数行为: - 支持 当显示弧设为"启用"时 |
示例
以下示例仅针对仪表盘小部件的配置字段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
}响应:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}