这些参数以及相应仪表板 widget 字段的可能属性值 objects 允许在 dashboard.create
和 dashboard.update
方法中配置 Item value widget。
widget fields
属性在仪表板创建或 update 期间不会进行验证。
这允许用户修改 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 分钟。 |
|
Item | 4 | itemid.0 | Item ID。 参数行为: - 如果未设置 监控项(小组件),则为必填 |
|
监控项(小组件) | 1 | itemid._reference | 除了使用 Item ID:ABCDE._itemid - 将一个 部件兼容性(其 Reference 参数设置为 "ABCDE ")设置为 监控项 的数据源。参数行为: - 如果未设置 监控项,则为必填 |
|
Show | 0 | show.0 | 1 - 描述; 2 - 值; 3 - 时间; 4 - 变化指示器。 默认值:1、2、3、4(全部启用)。 注意:要配置多个值,请为每个值使用递增的属性名,create 仪表板 widget 字段 object。 |
|
Override host | 1 | override_hostid._reference | ABCDE._hostid - 将一个 部件兼容性(其 Reference 参数设置为 "ABCDE ")设置为 主机 的数据源;DASHBOARD._hostid - 将仪表板 覆盖主机 设置为 主机 的数据源。如果在 template dashboard 上配置 widget,则不支持此参数。 |
以下高级配置参数支持用于监控项值小部件。
阈值属性名称中的数字(例如 thresholds.0.color)引用的是按升序排列的列表中的阈值位置。 但是,如果阈值以不同的顺序配置,在Zabbix前端更新小部件get配置后,这些值将按升序排列。 (例如. "thresholds.0.threshold":"5"
→ "thresholds.0.threshold":"1"
; "thresholds.1.threshold":"1"
→ "thresholds.1.threshold": "5"
)。
参数 | 仪表板小部件字段 | 名称 | 值 | |
---|---|---|---|---|
Background color | 1 | bg_color | 十六进制颜色代码(例如 FF0000 )。 默认值: "" (空)。 |
|
Thresholds | ||||
颜色 | 1 | thresholds.0.color | 十六进制颜色代码(例如 FF0000 )。 |
|
阈值 | 1 | thresholds.0.threshold | 任意string值。 | |
Aggregation function | 0 | aggregate_function | 0 - (默认) 未使用; 1 - 最小值; 2 - 最大值; 3 - 平均值; 4 - 计数; 5 - 总和; 6 - 第一个; 7 - 最后一个。 |
|
Time period | 1 | time_period._reference | DASHBOARD._timeperiod - 将Time period selector设置为数据源;ABCDE._timeperiod - 将部件兼容性(其 reference 参数等于 ABCDE )设置为数据源。默认值: DASHBOARD._timeperiod 或者,您可以在From和To参数中仅设置时间段。 参数行为: - 如果聚合函数设置为 "min"、"max"、"avg"、"count"、"sum"、"first"、"last",则支持 |
|
From | 1 | time_period.from | 以绝对时间(YYYY-MM-DD hh:mm:ss )或relative时间语法(now 、now/d 、now/w-1w 等)表示的有效时间string。参数行为: - 如果未设置时间段且聚合函数设置为 "min"、"max"、"avg"、"count"、"sum"、"first"、"last",则支持 |
|
To | 1 | time_period.to | 以绝对时间(YYYY-MM-DD hh:mm:ss )或relative时间语法(now 、now/d 、now/w-1w 等)表示的有效时间string。参数行为: - 如果未设置时间段且聚合函数设置为 "min"、"max"、"avg"、"count"、"sum"、"first"、"last",则支持 |
|
History data | 0 | history | 0 - (默认) 自动; 1 - 历史数据; 2 - 趋势数据。 |
如果将 显示 设为 "描述",则支持以下高级配置参数。
参数 | 仪表板小部件字段 | 名称 | 值 |
---|---|---|---|
Description | 1 | description | 任意 string 值,包括宏。 支持的宏:{主机.*}, {监控项.*}, {INVENTORY.*}, 用户宏。 默认值:{ITEM.NAME}。 |
Horizontal position | 0 | desc_h_pos | 0 - 左对齐; 1 - (默认) 居中; 2 - 右对齐。 两个或多个元素(描述、值、时间)不能共享相同的水平位置和垂直位置。 |
Vertical position | 0 | desc_v_pos | 0 - Top; 1 - 中间; 2 - (默认) 底部。 两个或多个元素(描述、值、时间)不能共享相同的水平位置和垂直位置。 |
Size | 0 | desc_size | 可能的取值范围为 1-100。 默认值:15。 |
Bold | 0 | desc_bold | 0 - (默认) 已禁用; 1 - 已启用。 |
Color | 1 | desc_color | 十六进制颜色代码(例如 FF0000 )。默认值: "" (空)。 |
如果将 显示 设置为 "值",则支持以下高级配置参数。
参数 | 仪表板小部件字段 | 名称 | 值 | |
---|---|---|---|---|
Decimal places | ||||
小数位数 | 0 | decimal_places | 可能的取值范围为 1-10。 默认值:2。 |
|
大小 | 0 | decimal_size | 可能的取值范围为 1-100。 默认值:35。 |
|
Position | ||||
水平位置 | 0 | value_h_pos | 0 - 左; 1 - (默认) 居中; 2 - 右。 两个或多个元素(描述、值、时间)不能共享相同的 水平位置 和 垂直位置。 |
|
垂直位置 | 0 | value_v_pos | 0 - Top; 1 - (默认) 中间; 2 - 底部。 两个或多个元素(描述、值、时间)不能共享相同的 水平位置 和 垂直位置。 |
|
大小 | 0 | value_size | 可能的取值范围为 1-100。 默认值:45。 |
|
加粗 | 0 | value_bold | 0 - 禁用; 1 - (默认) 启用。 |
|
颜色 | 1 | value_color | 十六进制颜色代码(例如 FF0000 )。默认值: "" (空)。 |
|
Units | ||||
单位(复选框) | 0 | units_show | 0 - 禁用; 1 - (默认) 启用。 |
|
单位(值) | 1 | units | 任意 string 值。 | |
位置 | 0 | units_pos | 0 - 值之前; 1 - 值上方; 2 - (默认) 值之后; 3 - 值下方。 |
|
大小 | 0 | units_size | 可能的取值范围为 1-100。 默认值:35。 |
|
加粗 | 0 | units_bold | 0 - 禁用; 1 - (默认) 启用。 |
|
颜色 | 1 | units_color | 十六进制颜色代码(例如 FF0000 )。默认值: "" (空)。 |
如果将 Show 设置为 "Time",则支持以下高级配置参数。
参数 | 仪表板小部件字段 | 名称 | 值 |
---|---|---|---|
Horizontal position | 0 | time_h_pos | 0 - 左对齐; 1 - (默认) 居中; 2 - 右对齐。 两个或多个元素(描述、值、时间)不能共享相同的水平位置和垂直位置。 |
Vertical position | 0 | time_v_pos | 0 - (默认) Top; 1 - 中间; 2 - 底部。 两个或多个元素(描述、值、时间)不能共享相同的 水平位置 和 垂直位置。 |
Size | 0 | time_size | 可能的取值范围为 1-100。 默认值:15。 |
Bold | 0 | time_bold | 0 - (默认) 已禁用; 1 - 已启用。 |
Color | 1 | time_color | 十六进制颜色代码(例如:FF0000 )。默认值: "" (空)。 |
以下高级配置参数在 Show 设置为 "Change indicator" 时受支持。
参数 | 仪表板小部件字段 | 名称 | 值 |
---|---|---|---|
Change indicator ↑ color | 1 | up_color | 十六进制颜色代码(例如 FF0000 )。默认值: "" (空)。 |
Change indicator ↓ color | 1 | down_color | 十六进制颜色代码(例如 FF0000 )。默认值: "" (空)。 |
Change indicator ↕ color | 1 | updown_color | 十六进制颜色代码(例如 FF0000 )。默认值: "" (空)。 |
以下示例仅用于描述如何配置仪表板 widget 字段 objects 以用于 监控项 值 小部件。 有关配置仪表板的更多信息,请参阅 dashboard.create
。
配置一个监控项值 widget,用于显示监控项 "42266"的监控项值(Zabbix agent可用性)。 此外,使用多种高级选项对widget进行视觉微调,包括根据Zabbix agent的可用性状态动态改变背景颜色。
执行请求:
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "item",
"name": "Item value",
"x": 0,
"y": 0,
"width": 12,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid.0",
"value": 42266
},
{
"type": 0,
"name": "show.0",
"value": 1
},
{
"type": 0,
"name": "show.1",
"value": 2
},
{
"type": 0,
"name": "show.2",
"value": 3
},
{
"type": 1,
"name": "description",
"value": "Agent status"
},
{
"type": 0,
"name": "desc_h_pos",
"value": 0
},
{
"type": 0,
"name": "desc_v_pos",
"value": 0
},
{
"type": 0,
"name": "desc_bold",
"value": 1
},
{
"type": 1,
"name": "desc_color",
"value": "F06291"
},
{
"type": 0,
"name": "value_h_pos",
"value": 0
},
{
"type": 0,
"name": "value_size",
"value": 25
},
{
"type": 1,
"name": "value_color",
"value": "FFFF00"
},
{
"type": 0,
"name": "units_show",
"value": 0
},
{
"type": 0,
"name": "time_h_pos",
"value": 2
},
{
"type": 0,
"name": "time_v_pos",
"value": 2
},
{
"type": 0,
"name": "time_size",
"value": 10
},
{
"type": 0,
"name": "time_bold",
"value": 1
},
{
"type": 1,
"name": "time_color",
"value": "9FA8DA"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "E1E1E1"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "0"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "D1C4E9"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "1"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Response: