Documentation
20 饼图
描述
这些参数以及相应仪表板 widget 字段的可能属性值 objects 允许在 dashboard.create 和 dashboard.update 方法中配置 Pie chart widget。
在仪表板创建或 update 过程中，不会验证 widget fields 属性。 这允许用户修改 built-in widgets 和 create custom widgets，但也带来了创建或更新部件时出错的风险。 为确保成功创建或 update 饼图 部件，请参考下表中列出的参数行为。
参数
饼图小部件支持以下参数。
| 参数 | 仪表板小部件字段 | 名称 | 值 |
|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 不刷新； 10 - 10 秒； 30 - 30 秒； 60 - (默认) 1 分钟； 120 - 2 分钟； 600 - 10 分钟； 900 - 15 分钟。 |
数据集
配置数据集时支持以下参数。
属性名称中的第一个数字（例如 ds.0.主机.0, ds.0.监控项.0）表示特定的数据集， 而第二个数字（如果存在）表示配置的 主机 或 监控项。
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| Data set type | 0 | ds.0.dataset_type | 0 - 监控项 列表； 1 - (默认) 监控项 模式。 |
|
| 监控项 | 4 | ds.0.itemids.0 | Item ID。 在template dashboard上配置widget时，仅应设置模板上配置的监控项。 注意：要配置多个监控项，请为每个监控项使用递增的属性名编号，create仪表板widget字段object。 参数行为： - 如果数据集类型设置为"监控项 列表"且未设置监控项 (Widget)，则为必填 |
|
| 监控项 (Widget) | 1 | ds.0.itemids.0._reference | 代替Item ID：ABCDE._itemid - 将部件兼容性（其引用参数设置为"ABCDE"）设置为监控项的数据源。注意：要配置多个小部件，请为每个widget使用递增的属性名编号，create仪表板widget字段object。 此参数自Zabbix 7.0.1起支持。 参数行为： - 如果数据集类型设置为"监控项 列表"且未设置监控项，则为必填 |
|
| 颜色 | 1 | ds.0.color.0 | 十六进制颜色代码（例如 FF0000）。参数行为： - 如果数据集类型设置为"监控项 列表"，则为支持 |
|
| 监控项 类型 | 0 | ds.0.type.0 | 0 - (默认) 正常； 1 - 总计。 值"总计"只能在整个图表中的一个监控项中设置。 参数行为： - 如果数据集类型设置为"监控项 列表"，则为支持 |
|
| 主机 模式 | 1 | ds.0.hosts.0 | Host名称或模式（例如 "Zabbix*"）。 参数行为： - 如果数据集类型设置为"监控项 模式"，则为必填 在template dashboard上配置widget时不支持此参数。 |
|
| 监控项 模式 | 1 | ds.0.items.0 | Item名称或模式（例如 "*: 每秒处理的*值数"）。 在template dashboard上配置widget时，仅应设置模板上配置的监控项的模式。 参数行为： - 如果数据集类型设置为"监控项 模式"，则为必填 |
|
| 颜色 | 1 | ds.0.color | 十六进制颜色代码（例如 FF0000）。参数行为： - 如果数据集类型设置为"监控项 模式"，则为支持 |
|
| Aggregation function | 0 | ds.0.aggregate_function | 1 - 最小值； 2 - 最大值； 3 - 平均值； 4 - 计数； 5 - 总和； 6 - 第一个； 7 - (默认) 最后一个。 |
|
| Data set aggregation | 0 | ds.0.dataset_aggregation | 0 - (默认) 无； 1 - 最小值； 2 - 最大值； 3 - 平均值； 4 - 计数； 5 - 总和。 参数行为： - 如果监控项 类型设置为"总计"，则为支持 |
|
| Data set label | 1 | ds.0.data_set_label | 任意string值。 默认值： ""（空）。 |
|
显示选项
配置显示选项时支持以下参数。
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| History data selection | 0 | source | 0 - (默认) 历史; 1 - 历史; 2 - 趋势。 |
|
| Draw | 0 | draw_type | 0 - (默认) 饼图; 1 - 圆环图。 |
|
| 宽度 | 0 | width | 20 - 20% 半径; 30 - 30% 半径; 40 - 40% 半径; 50 - (默认) 50% 半径。 参数行为: - 支持 如果“绘制”设置为“圆环图” |
|
| 描边宽度 | 0 | stroke | 可选值范围为 0-10。 默认值: 0。 自 Zabbix 7.0.1 起支持此参数。 参数行为: - 支持 如果“绘制”设置为“圆环图” |
|
| 显示总值 | 0 | total_show | 0 - (默认) 禁用; 1 - 启用。 参数行为: - 支持 如果“绘制”设置为“圆环图” |
|
| 大小 | 0 | value_size_type | 0 - (默认) 自动; 1 - 自定义。 参数行为: - 支持 如果“显示总值”设置为“启用” |
|
| 大小 (自定义大小的值) | 0 | value_size | 可选值范围为 1-100。 默认值: 20。 参数行为: - 支持 如果“显示总值”设置为“启用” |
|
| 小数位数 | 0 | decimal_places | 可选值范围为 0-6。 默认值: 2。 参数行为: - 支持 如果“显示总值”设置为“启用” |
|
| 单位 (复选框) | 0 | units_show | 0 - (默认) 禁用; 1 - 启用。 参数行为: - 支持 如果“显示总值”设置为“启用” |
|
| 单位 (值) | 1 | units | 任意 string 值。 参数行为: - 支持 如果“单位”(复选框)设置为“启用” |
|
| 粗体 | 0 | value_bold | 0 - (默认) 禁用; 1 - 启用。 参数行为: - 支持 如果“显示总值”设置为“启用” |
|
| 颜色 | 1 | value_color | 十六进制颜色代码 (例如 FF0000)。参数行为: - 支持 如果“显示总值”设置为“启用” |
|
| Space between sectors | 0 | space | 可选值范围为 0-10。 默认值: 1。 |
|
| Merge sectors smaller than N% (checkbox) | 0 | merge | 0 - (默认) 禁用; 1 - 启用。 |
|
| Merge sectors smaller than N% (value) | 0 | merge_percent | 可选值范围为 1-10。 默认值: 1。 参数行为: - 支持 如果“合并小于 N% 的扇区”(复选框)设置为“启用” |
|
| Merge sectors smaller than N% (color) | 1 | merge_color | 十六进制颜色代码 (例如 FF0000)。参数行为: - 支持 如果“合并小于 N% 的扇区”(复选框)设置为“启用” |
|
时间段
用于配置时间段，支持以下参数。
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| Time period | 1 | time_period._reference | DASHBOARD._timeperiod - 将 Time period selector 设置为数据源；ABCDE._timeperiod - 将一个 部件兼容性（将其 Reference 参数设置为 "ABCDE"）设置为数据源。默认值: DASHBOARD._timeperiod或者，您也可以仅在 From 和 To 参数中设置时间段。 |
|
| From | 1 | time_period.from | 以绝对时间 (YYYY-MM-DD hh:mm:ss) 或 relative 时间语法 (now、now/d、now/w-1w 等) 表示的有效时间 string。参数行为: - 如果未设置 时间段，则 支持 |
|
| To | 1 | time_period.to | 以绝对时间 (YYYY-MM-DD hh:mm:ss) 或 relative 时间语法 (now、now/d、now/w-1w 等) 表示的有效时间 string。参数行为: - 如果未设置 时间段，则 支持 |
|
图例
用于配置图例（Legend），支持以下参数。
| 参数 | 仪表板小部件字段 | 名称 | 值 |
|---|---|---|---|
| Show legend | 0 | legend | 0 - 已禁用； 1 - (默认) 已启用。 |
| Show value | 0 | legend_value | 0 - (默认) 已禁用； 1 - 已启用。 参数行为: - 如果显示图例（Show legend）设置为"已启用（Enabled）"，则支持（supported） |
| Show aggregation function | 0 | legend_aggregation | 0 - (默认) 已禁用； 1 - 已启用。 参数行为: - 如果显示图例（Show legend）设置为"已启用（Enabled）"，则支持（supported） |
| Rows | 0 | legend_lines_mode | 0 - (默认) 固定（Fixed）； 1 - 可变（Variable）。 参数行为: - 如果显示图例（Show legend）设置为"已启用（Enabled）"，则支持（supported） |
| Number of rows/ Maximum number of rows |
0 | legend_lines | 可能的值范围为 1-10。 默认值：1。 参数行为: - 如果显示图例（Show legend）设置为"已启用（Enabled）"，则支持（supported） |
| Number of columns | 0 | legend_columns | 可能的值范围为 1-4。 默认值：4。 参数行为: - 如果显示图例（Show legend）设置为"已启用（Enabled）"，且显示值（Show value）设置为"已禁用（Disabled）"，则支持（supported） |
示例
以下示例仅用于描述仪表板中饼图小部件的宽get字段objects的配置。 有关配置仪表板的更多信息，请参见dashboard.create。
配置饼图小部件
以以下方式配置一个饼图 widget：
- 2 数据集，总共包含 9 监控项，位于 1 主机 上。
- 第一个数据集类型为 "监控项 list"，由 3 监控项 组成，所有类型均为 "Normal"，并以不同颜色表示。
- 第二个数据集类型为 "监控项 patterns"，由 6 监控项 组成，每个 监控项 配置了聚合方式，并以自定义颜色表示。
- 第二个数据集还配置了自定义数据集标签。
- 饼图中的数据显示为环形图，具有自定义宽度、中心显示的总计值及单位。
- 饼图中的数据显示和聚合针对自定义时间段，即最近的 3 小时。
- 饼图图例在 4 行中显示配置的 监控项。
执行请求:
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "piechart",
"name": "Pie chart",
"x": 0,
"y": 0,
"width": 24,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "ds.0.dataset_type",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "FF0000"
},
{
"type": 0,
"name": "ds.0.type.1",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "BF00FF"
},
{
"type": 0,
"name": "ds.0.type.2",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.3",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.3",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.type.3",
"value": 0
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.1.items.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.1.color",
"value": "000000"
},
{
"type": 0,
"name": "ds.1.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "draw_type",
"value": 1
},
{
"type": 0,
"name": "width",
"value": 30
},
{
"type": 0,
"name": "total_show",
"value": 1
},
{
"type": 0,
"name": "units_show",
"value": 1
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 0,
"name": "legend_lines",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: