32 Web 监控
说明
各个仪表盘组件字段对象中的这些参数和可用属性值允许在dashboard.create 和 dashboard.update 方法中配置Web监测组件。
在创建或更新仪表盘期间不会验证组件的 fields 属性。
这个方法允许用户修改内置组件和创建自定义组件,但也会导致存在错误创建或更新组件的风险。
为确保成功创建或更新Web监测组件,请参阅下表中概述的参数行为。
参数
以下参数适用于 Web 监控 小组件。
| 参数 | type | name | value | |
|---|---|---|---|---|
| 刷新间隔 | 0 | rf_rate | 0 - 不刷新; 10 - 10 秒; 30 - 30 秒; 60 - (默认) 1 分钟; 120 - 2 分钟; 600 - 10 分钟; 900 - 15 分钟。 |
|
| 主机群组 | 2 | groupids.0 | 主机群组 ID。 注意:要配置多个主机群组,请为每个主机群组创建一个 dashboard 小组件字段对象,并在属性名中递增编号。 如果在 模板 dashboard 上配置该小组件,则不支持此参数。 |
|
| 主机群组(小组件) | 1 | groupids._reference | 不使用 主机群组 ID,而是:ABCDE._hostgroupids - 将 兼容小组件(其 Reference 参数设置为 "ABCDE")设为主机群组的数据源。如果在 模板 dashboard 上配置该小组件,则不支持此参数。 |
|
| 排除主机群组 | 2 | exclude_groupids.0 | 主机群组 ID。 注意:要排除多个主机群组,请为每个主机群组创建一个 dashboard 小组件字段对象,并在属性名中递增编号。 如果在 模板 dashboard 上配置该小组件,则不支持此参数。 |
|
| 主机 | 3 | hostids.0 | 主机 ID。 注意:要配置多个主机,请为每个主机创建一个 dashboard 小组件字段对象,并在属性名中递增编号。对于多个主机,参数 主机群组 要么完全不配置,要么至少配置一个所选主机所属的主机群组。 如果在 模板 dashboard 上配置该小组件,则不支持此参数。 |
|
| 主机(小组件/仪表板) | 1 | hostids._reference | 不使用 主机 ID,而是:DASHBOARD.hostids - 将 主机 选择器 设为主机的数据源;ABCDE._hostids - 将 兼容小组件(其 Reference 参数设置为 "ABCDE")设为主机的数据源。如果在 模板 dashboard 上配置该小组件,则不支持此参数。 |
|
| 场景标签 | ||||
| 评估类型 | 0 | evaltype | 0 - (默认) 与/或; 2 - 或。 |
|
| 标签名 | 1 | tags.0.tag | 任意字符串值。 注意:属性名中的数字表示标签在标签评估列表中的顺序。 参数行为: - 如果配置 场景标签,则为必填 |
|
| 运算符 | 0 | tags.0.operator | 0 - 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在。 注意:属性名中的数字表示标签在标签评估列表中的顺序。 参数行为: - 如果配置 场景标签,则为必填 |
|
| 标签值 | 1 | tags.0.value | 任意字符串值。 注意:属性名中的数字表示标签在标签评估列表中的顺序。 参数行为: - 如果配置 场景标签,则为必填 |
|
| 在维护中显示主机 | 0 | maintenance | 0 - 禁用; 1 - (默认) 启用。 |
|
| Reference | 1 | reference | 任意由 5 个字符组成的字符串值(例如 ABCDE 或 JBPNL)。此值在该小组件所属的 dashboard 中必须唯一。参数行为: - 必填 |
|
示例
以下示例仅用于介绍如何在仪表盘组件字段对象中配置 Web监测 组件。 更多信息,请参考 创建仪表盘。
配置一个Web监测组件
配置一个 Web监测 组件,用于展示主机组 "4" 中已启用的 Web 场景的状态概览。
请求:
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "web",
"name": "Web monitoring",
"x": 0,
"y": 0,
"width": 18,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
响应:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}