25 散点图
描述
这些参数以及相应仪表板小部件字段对象的可选属性值，可用于在 dashboard.create 和 dashboard.update 方法中配置 散点图 小部件。
小部件 fields 属性在创建或更新仪表板时不会进行验证。
这使用户能够修改内置小部件并创建自定义小部件，但同时也会带来错误创建或更新小部件的风险。
为确保 散点图 小部件能够成功创建或更新，请参阅下表中列出的参数行为。
参数
以下参数适用于 散点图 部件。
| 参数 | type | name | value |
|---|---|---|---|
| 刷新间隔 | 0 | rf_rate | 0 - 不刷新； 10 - 10 秒； 30 - 30 秒； 60 - (默认) 1 分钟； 120 - 2 分钟； 600 - 10 分钟； 900 - 15 分钟。 |
| 引用 | 1 | reference | 由 5 个字符组成的任意字符串值（例如：ABCDE 或 JBPNL）。该值在部件所属的仪表板内必须唯一。参数行为： - 必填 |
数据集
支持使用以下参数配置数据集。
属性名称中的第一个数字（例如 ds.0.hosts.0、ds.0.items.0）表示特定的数据集， 而第二个数字（如果存在）表示已配置的主机或监控项。
| 参数 | < | type | 名称 | 值 | |
|---|---|---|---|---|---|
| 数据集类型 | < | 0 | ds.0.dataset_type | 0 - 监控项列表； 1 - (默认) 监控项模式。 |
|
| 数据集：监控项列表 | < | < | < | ||
| 颜色 | < | 1 | ds.0.color.0 | 十六进制颜色代码（例如 FF0000）。参数行为： - 如果数据集类型设置为“监控项列表”，则为必需 |
|
| X 轴 | < | 4 | ds.0.x_axis_itemids.0 | 监控项 ID。 在模板仪表板上配置该部件时，只应设置模板上已配置的监控项。 注意：要配置多个监控项，请为每个监控项创建一个仪表板部件字段对象，并在属性名称中使用递增的编号。 参数行为： - 如果数据集类型设置为“监控项列表”且未设置X 轴（部件），则为必需 |
|
| X 轴（部件） | < | 1 | ds.0.x_axis_itemids.0._reference | 用于替代监控项 ID：ABCDE._itemid - 将兼容部件（其Reference参数设置为“ABCDE”）设置为监控项的数据源。注意：要配置多个部件，请为每个部件创建一个仪表板部件字段对象，并在属性名称中使用递增的编号。 参数行为： - 如果数据集类型设置为“监控项列表”且未设置X 轴，则为必需 |
|
| Y 轴 | < | 4 | ds.0.y_axis_itemids.0 | 监控项 ID。 在模板仪表板上配置该部件时，只应设置模板上已配置的监控项。 注意：要配置多个监控项，请为每个监控项创建一个仪表板部件字段对象，并在属性名称中使用递增的编号。 参数行为： - 如果数据集类型设置为“监控项列表”且未设置Y 轴（部件），则为必需 |
|
| Y 轴（部件） | < | 1 | ds.0.y_axis_itemids.0._reference | 用于替代监控项 ID：ABCDE._itemid - 将兼容部件（其Reference参数设置为“ABCDE”）设置为监控项的数据源。注意：要配置多个部件，请为每个部件创建一个仪表板部件字段对象，并在属性名称中使用递增的编号。 参数行为： - 如果数据集类型设置为“监控项列表”且未设置Y 轴，则为必需 |
|
| 覆盖主机 | < | 1 | ds.0.override_hostid._reference | ABCDE._hostid - 将兼容部件（其“Reference”参数设置为“ABCDE”）设置为主机的数据源；DASHBOARD._hostid - 将仪表板主机选择器设置为主机的数据源。如果在模板仪表板上配置该部件，则不支持此参数。 |
|
| 数据集：监控项模式 | < | < | < | ||
| 颜色 | < | 1 | ds.0.color | 十六进制颜色代码（例如 FF0000）。参数行为： - 如果数据集类型设置为“监控项模式”且未设置调色板，则支持 |
|
| 调色板 | < | 0 | ds.0.color_palette | 调色板索引。 可能的值范围：0-11。 默认值：0。 参数行为： - 如果数据集类型设置为“监控项模式”且未设置颜色，则支持 |
|
| 主机模式 | < | 1 | ds.0.hosts.0 | 主机名称或模式（例如，“Zabbix*”）。 参数行为： - 如果数据集类型设置为“监控项模式”，则为必需 如果在模板仪表板上配置该部件，则不支持此参数。 |
|
| X 轴监控项模式 | < | 1 | ds.0.x_axis_items.0 | 监控项名称或模式（例如，“*: Number of processed *values per second”）。 在模板仪表板上配置该部件时，只应设置模板上已配置监控项的模式。 参数行为： - 如果数据集类型设置为“监控项模式”，则为必需 |
|
| Y 轴监控项模式 | < | 1 | ds.0.y_axis_items.0 | 监控项名称或模式（例如，“*: Number of processed *values per second”）。 在模板仪表板上配置该部件时，只应设置模板上已配置监控项的模式。 参数行为： - 如果数据集类型设置为“监控项模式”，则为必需 |
|
| 主机群组 | < | 2 | groupids.0 | 主机群组 ID。 注意：要配置多个主机群组，请为每个主机群组创建一个仪表板部件字段对象，并在属性名称中使用递增的编号。 如果在模板仪表板上配置该部件，则不支持此参数。 |
|
| 主机群组（部件） | < | 1 | groupids._reference | 用于替代主机群组 ID：ABCDE._hostgroupids - 将兼容部件（其Reference参数设置为“ABCDE”）设置为主机群组的数据源。如果在模板仪表板上配置该部件，则不支持此参数。 |
|
| 覆盖主机 | < | 1 | ds.0.override_hostid._reference | ABCDE._hostid - 将兼容部件（其“Reference”参数设置为“ABCDE”）设置为主机的数据源；DASHBOARD._hostid - 将仪表板主机选择器设置为主机的数据源。如果在模板仪表板上配置该部件，则不支持此参数。 |
|
| 主机标签 | < | < | < | < | |
| < | 评估类型 | 0 | evaltype_host | 0 - (默认) And/Or； 2 - Or。 如果在模板仪表板上配置该部件，则不支持此参数。 |
|
| ^ | 标签名称 | 1 | host_tags.0.tag | 任意字符串值。 注意：属性名称中的数字表示标签评估列表中的标签顺序。 参数行为： - 如果配置了主机标签，则为必需 如果在模板仪表板上配置该部件，则不支持此参数。 |
|
| ^ | 运算符 | 0 | host_tags.0.operator | 0 - 包含； 1 - 等于； 2 - 不包含； 3 - 不等于； 4 - 存在； 5 - 不存在。 注意：属性名称中的数字表示标签评估列表中的标签顺序。 参数行为： - 如果配置了主机标签，则为必需 如果在模板仪表板上配置该部件，则不支持此参数。 |
|
| ^ | 标签值 | 1 | host_tags.0.value | 任意字符串值。 注意：属性名称中的数字表示标签评估列表中的标签顺序。 参数行为： - 如果配置了主机标签，则为必需 如果在模板仪表板上配置该部件，则不支持此参数。 |
|
| 标记 | < | 0 | ds.0.marker | 0 - (默认) 椭圆； 1 - 方形； 2 - 三角形； 3 - 菱形； 4 - 星形； 5 - 十字形。 |
|
| 标记大小 | < | 0 | ds.0.marker_size | 0 - (默认) 小（6px）； 1 - 中（9px）； 2 - 大（15px）。 |
|
| 时间偏移 | < | 1 | ds.0.timeshift | 有效的时间字符串（例如 3600、1h 等）。你可以使用时间后缀。也允许使用负值。 默认值： ""（空）。 |
|
| 聚合间隔 | < | 1 | ds.0.aggregate_interval | 有效的时间字符串（例如 3600、1h 等）。你可以使用时间后缀。 默认值： 15m。 |
|
| 聚合函数 | < | 0 | ds.0.aggregate_function | 0 - 不使用； 1 - min； 2 - max； 3 - (默认) avg； 4 - count； 5 - sum； 6 - first； 7 - last。 |
|
显示选项
以下参数支持用于配置显示选项。
| 参数 | type | name | value |
|---|---|---|---|
| 历史数据选择 | 0 | source | 0 - (默认) 自动； 1 - 历史数据； 2 - 趋势。 |
| 标签中的主机名称 | 0 | show_hostnames | 0 - (默认) 自动； 1 - 显示； 2 - 隐藏。 如果在模板仪表板上配置该小组件，则不支持此参数。 |
时间段
以下参数支持用于配置 时间段。
| 参数 | type | name | value | |
|---|---|---|---|---|
| 时间段 | 1 | time_period._reference | DASHBOARD._timeperiod - 将仪表板时间段选择器设置为数据源；ABCDE._timeperiod - 将兼容的部件（其 Reference 参数设置为“ABCDE”）设置为数据源。默认值： DASHBOARD._timeperiod或者，您也可以仅在 From 和 To 参数中设置时间段。 |
|
| From | 1 | time_period.from | 绝对（YYYY-MM-DD hh:mm:ss）或相对时间语法（now、now/d、now/w-1w 等）中的有效时间字符串。参数行为： - 如果未设置 时间段，则支持 - 如果设置了 time_period.to，则必需 |
|
| To | 1 | time_period.to | 绝对（YYYY-MM-DD hh:mm:ss）或相对时间语法（now、now/d、now/w-1w 等）中的有效时间字符串。参数行为： - 如果未设置 时间段，则支持 - 如果设置了 time_period.from，则必需 |
|
坐标轴
以下参数支持用于配置 坐标轴。
| 参数 | type | name | value |
|---|---|---|---|
| X 轴 | 0 | x_axis | 0 - 禁用； 1 - (默认) 启用。 |
| Y 轴 | 0 | y_axis | 0 - (默认) 禁用； 1 - 启用。 |
| 最小值 | 1 | x_axis_min | 任意数值。 默认值： ""（空）。 |
| y_axis_min | |||
| 最大值 | 1 | x_axis_max | 任意数值。 默认值： ""（空）。 |
| y_axis_max | |||
| 单位（类型） | 0 | x_axis_units | 0 - (默认) 自动； 1 - 静态。 |
| y_axis_units | |||
| 单位（值） | 1 | x_axis_static_units | 任意字符串值。 默认值： ""（空）。 |
| y_axis_static_units |
图例
以下参数可用于配置 图例。
| 参数 | type | name | value |
|---|---|---|---|
| 显示图例 | 0 | legend | 0 - 禁用； 1 - (默认) 启用。 |
| 显示聚合函数 | 0 | legend_aggregation | 0 - (默认) 禁用； 1 - 启用。 参数行为： - 如果 显示图例 设置为“启用”，则 supported |
| 行数 | 0 | legend_lines_mode | 0 - (默认) 固定； 1 - 可变。 参数行为： - 如果 显示图例 设置为“启用”，则 supported |
| 行数/ 最大行数 |
0 | legend_lines | 可能的取值范围：1-10。 默认值：1。 参数行为： - 如果 显示图例 设置为“启用”，则 supported |
| 列数 | 0 | legend_columns | 可能的取值范围：1-4。 默认值：4。 参数行为： - 如果 显示图例 设置为“启用”，则 supported |
阈值
支持以下参数来配置阈值。
Thresholds 属性名称中的数字（例如 thresholds.0.color）表示按升序排序的列表中的阈值位置。
但是，如果阈值以不同顺序配置，那么在 Zabbix 前端中更新部件配置后，这些值将按升序排序
（例如，"thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"；"thresholds.1.threshold":"1" → "thresholds.1.threshold": "5"）。
| 参数 | type | name | value |
|---|---|---|---|
| 颜色插值 | 0 | interpolation | 0 - （默认） 禁用； 1 - 启用。 |
| 颜色 | 1 | thresholds.0.color | 十六进制颜色代码（例如 FF0000）。 |
| X 轴 | 1 | thresholds.0.x_axis_threshold | 任意数值。支持后缀（例如 "1d"、"2w"、"4K"、"8G"）。 |
| Y 轴 | 1 | thresholds.0.y_axis_threshold | 任意数值。支持后缀（例如 "1d"、"2w"、"4K"、"8G"）。 |
示例
以下示例仅用于说明 散点图 部件的仪表板部件字段对象的配置。
有关配置仪表板的更多信息，请参见 dashboard.create。
配置 散点图 小组件
按以下方式配置 散点图 小组件：
- 5 个类型为“监控项模式”的数据集，每个数据集均使用默认聚合（avg，15m）和不同的标记。
- 图例以单行两列显示已配置的监控项。
- 配置阈值后，当标记在任一坐标轴上的值达到 80 时，将其着色为红色。
请求：
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "scatterplot",
"name": "Scatter plot",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "ds.0.color",
"value": "0C5A87"
},
{
"type": 1,
"name": "ds.0.hosts.0",
"value": "de-frankfurt*"
},
{
"type": 1,
"name": "ds.0.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.0.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.0.marker",
"value": 0
},
{
"type": 0,
"name": "ds.0.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.1.color",
"value": "66B0D9"
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "fr-paris*"
},
{
"type": 1,
"name": "ds.1.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.1.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.1.marker",
"value": 1
},
{
"type": 0,
"name": "ds.1.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.2.color",
"value": "0A466A"
},
{
"type": 1,
"name": "ds.2.hosts.0",
"value": "lv-riga*"
},
{
"type": 1,
"name": "ds.2.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.2.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.2.marker",
"value": 2
},
{
"type": 0,
"name": "ds.2.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.3.color",
"value": "3394C3"
},
{
"type": 1,
"name": "ds.3.hosts.0",
"value": "pl-warsaw*"
},
{
"type": 1,
"name": "ds.3.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.3.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.3.marker",
"value": 3
},
{
"type": 0,
"name": "ds.3.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.4.color",
"value": "1492C8"
},
{
"type": 1,
"name": "ds.4.hosts.0",
"value": "se-stockholm*"
},
{
"type": 1,
"name": "ds.4.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.4.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.4.marker",
"value": 4
},
{
"type": 0,
"name": "ds.4.marker_size",
"value": 1
},
{
"type": 0,
"name": "legend_columns",
"value": 2
},
{
"type": 0,
"name": "interpolation",
"value": 1
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "D40000"
},
{
"type": 1,
"name": "thresholds.0.x_axis_threshold",
"value": "80"
},
{
"type": 1,
"name": "thresholds.0.y_axis_threshold",
"value": ""
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "D40000"
},
{
"type": 1,
"name": "thresholds.1.x_axis_threshold",
"value": ""
},
{
"type": 1,
"name": "thresholds.1.y_axis_threshold",
"value": "80"
},
{
"type": 1,
"name": "reference",
"value": "JQISY"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}