这些参数以及相应仪表板 widget 字段 objects 的可能属性值用于配置 在 dashboard.create
和 dashboard.update
方法中的 Problems widget。
::: noteimportant 在创建仪表板或update期间,不会验证Widget fields
属性。 这允许用户修改built-in widgets和create custom widgets,但也引入了错误创建或更新小部件的风险。 为确保成功创建或update“问题(Problems)”小部件,请参考下表中概述的参数行为。 仅返回OutputFormat格式要求结果
以下参数受问题小部件支持。
参数 | 仪表板小部件字段 | 名称 | 值 | |
---|---|---|---|---|
Refresh interval | 0 | rf_rate | 0 - 无刷新; 10 - 10 秒; 30 - 30 秒; 60 - (默认) 1 分钟; 120 - 2 分钟; 600 - 10 分钟; 900 - 15 分钟。 |
|
Show | 0 | show | 1 - (默认) 最近问题; 2 - 历史; 3 - 问题。 |
|
Host groups | 2 | groupids.0 | Host group ID。 注意:要配置多个 主机 组,需为每个 主机组 使用递增的属性名称 create 仪表板 widget 字段 object。 如果在 template dashboard 上配置 widget,则不支持此参数。 |
|
主机 组(小部件) | 1 | groupids._reference | 请勿使用Host group ID:ABCDE._hostgroupids - 应将一个部件兼容性(将其Reference参数设置为"ABCDE ")设置为监控项主机组的数据源。如果在template dashboard上配置小get,则不支持此参数。 |
|
Exclude host groups | 2 | exclude_groupids.0 | Host group ID。 注意:若要排除多个 主机 组,需为每个 主机组 使用递增的属性名称编号,create 一个仪表板 widget 字段 object。 如果在 template dashboard 上配置 widget,则不支持此参数。 |
|
Hosts | 3 | hostids.0 | Host ID。 注意:要配置多个 主机,请create一个仪表板 widget 字段 object,并为每个 主机 在属性名称中使用递增的编号。对于多个 主机,参数 主机 组 必须完全未配置,或者至少配置一个 主机组,且配置的 主机 必须属于该组。 如果在 template dashboard 上配置 widget,则不支持此参数。 |
|
主机 (小部件/仪表板) | 1 | hostids._reference | 不使用 Host ID:DASHBOARD.hostids - 将 覆盖主机 设置为 主机 的数据源;ABCDE._hostids - 将一个 部件兼容性(将其 Reference 参数设置为 "ABCDE ")设置为 主机 的数据源。如果在 template dashboard 上配置小get,则不支持此参数。 |
|
Problem | 1 | problem | 问题 配置(不区分大小写,完整名称或其部分)。 | |
Severity | 0 | severities.0 | 0 - 未分类; 1 - 信息; 2 - 警告; 3 - 一般; 4 - 高; 5 - 灾难。 默认值:空(全部启用)。 注意:要配置多个值,请为每个值使用递增的编号在属性名称中,并为每个值create仪表板widget字段object。 |
|
Problem tags | ||||
评估类型 | 0 | evaltype | 0 - (默认) And/Or; 2 - Or. |
|
标签名称 | 1 | tags.0.tag | 任意 string 值。 注意:属性名称中的数字表示标签在标签评估列表中的顺序。 参数行为: - 若配置 Problem tags 则为必填项 |
|
操作符 | 0 | tags.0.operator | 0 - 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在。 注意:属性名称中的数字引用标签评估列表中的标签顺序。 参数行为: - 如果配置“问题标签”则为必填。 |
|
标签值 | 1 | tags.0.value | 任意 string 值。 注意:属性名称中的数字引用了标签评估列表中的标签顺序。 参数行为: - 若配置 问题标签 则为必填 |
|
Show tags | 0 | show_tags | 0 - (默认) 无; 1 - 1; 2 - 2; 3 - 3。 |
|
Tag name (format) | 0 | tag_name_format | 0 - (默认) 完整; 1 - 简化; 2 - 无。 参数行为: - 如果“显示标签”设置为“1”、“2”或“3”,则为支持。 |
|
Tag display priority | 1 | tag_priority | 逗号分隔的标签列表。 参数行为: - 如果“显示标签”设置为“1”、“2”或“3”,则为“支持”。 |
|
Show operational data | 0 | show_opdata | 0 - (默认) 无; 1 - 单独; 2 - 与问题名称一起。 |
|
Show suppressed problems | 0 | show_suppressed | 0 - (默认) 已禁用; 1 - 已启用。 |
|
Acknowledgement status | 0 | acknowledgement_status | 0 - (默认) 所有; 1 - 未确认; 2 - 已确认。 |
|
By me | 0 | acknowledged_by_me | 0 - (默认) 已禁用; 1 - 已启用。 |
|
Sort entries by | 0 | sort_triggers | 1 - 严重程度(降序); 2 - 主机(升序); 3 - 时间(升序); 4 - (默认) 时间(降序); 13 - 严重程度(升序); 14 - 主机(降序); 15 - 问题(升序); 16 - 问题(降序)。 除“时间(降序)”和“时间(升序)”外,所有值都要求将显示时间轴参数设置为“禁用”。 如果在template dashboard上配置widget,则不支持值“主机(升序)”和“主机(降序)”。 |
|
Show timeline | 0 | show_timeline | 0 - 已禁用; 1 - (默认) 已启用。 参数行为: - 如果将“按条目排序方式”设置为“时间(降序)”或“时间(升序)”,则为 支持。 |
|
Show lines | 0 | show_lines | 可能的取值范围为 1-100。 默认值:25。 |
|
Reference | 1 | reference | 任何由 5 个字符组成的 string 值(例如 ABCDE 或 JBPNL )。此值在该 widget 所属的仪表板中必须唯一。参数行为: - 必填 |
以下示例仅用于描述如何为 问题(Problems) 小组件配置仪表板 widget 字段 objects。 有关配置仪表板的更多信息,请参见 dashboard.create
。
配置一个问题小部件get,用于显示监控项"主机组" "4" 的问题,并满足以下条件:
此外,配置该小部件get以显示标签和操作数据。
执行请求:
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problems",
"name": "Problems",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 1,
"name": "tags.0.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "tags.0.value",
"value": "performance"
},
{
"type": 1,
"name": "tags.1.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.1.operator",
"value": 0
},
{
"type": 1,
"name": "tags.1.value",
"value": "availability"
},
{
"type": 1,
"name": "tags.2.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.2.operator",
"value": 0
},
{
"type": 1,
"name": "tags.2.value",
"value": "capacity"
},
{
"type": 0,
"name": "severities.0",
"value": 2
},
{
"type": 0,
"name": "severities.1",
"value": 3
},
{
"type": 0,
"name": "severities.2",
"value": 4
},
{
"type": 0,
"name": "severities.3",
"value": 5
},
{
"type": 0,
"name": "show_tags",
"value": 1
},
{
"type": 0,
"name": "show_opdata",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
响应: