23 问题
描述
这些参数以及相应仪表板小部件字段对象的可选属性值,可用于在 dashboard.create 和 dashboard.update 方法中配置 Problems 小部件。
小部件 fields 属性在创建或更新仪表板期间不会被验证。
这使用户能够修改内置小部件并创建自定义小部件,但也会带来错误创建或更新小部件的风险。
为确保成功创建或更新 Problems 小部件,请参阅下表中列出的参数行为。
参数
问题 部件支持以下参数。
| 参数 | type | name | value | |
|---|---|---|---|---|
| 刷新间隔 | 0 | rf_rate | 0 - 不刷新; 10 - 10 秒; 30 - 30 秒; 60 - (默认) 1 分钟; 120 - 2 分钟; 600 - 10 分钟; 900 - 15 分钟。 |
|
| 显示 | 0 | show | 1 - (默认) 最近的问题; 2 - 历史; 3 - 问题。 |
|
| 主机群组 | 2 | groupids.0 | 主机群组 ID。 注意:要配置多个主机群组,请为每个主机群组创建一个 dashboard 部件字段对象,并在属性名称中使用递增的编号。 如果在模板仪表板上配置该部件,则不支持此参数。 |
|
| 主机群组(部件) | 1 | groupids._reference | 用于替代 主机群组 ID:ABCDE._hostgroupids - 将兼容部件(其 Reference 参数设置为 "ABCDE")设置为主机群组的数据源。如果在模板仪表板上配置该部件,则不支持此参数。 |
|
| 排除主机群组 | 2 | exclude_groupids.0 | 主机群组 ID。 注意:要排除多个主机群组,请为每个主机群组创建一个 dashboard 部件字段对象,并在属性名称中使用递增的编号。 如果在模板仪表板上配置该部件,则不支持此参数。 |
|
| 主机 | 3 | hostids.0 | 主机 ID。 注意:要配置多个主机,请为每个主机创建一个 dashboard 部件字段对象,并在属性名称中使用递增的编号。对于多个主机,参数 主机群组 必须要么完全不配置,要么至少配置一个包含所配置主机的主机群组。 如果在模板仪表板上配置该部件,则不支持此参数。 |
|
| 主机(部件/仪表板) | 1 | hostids._reference | 用于替代 主机 ID:DASHBOARD.hostids - 将仪表板的主机选择器设置为主机的数据源;ABCDE._hostids - 将兼容部件(其 Reference 参数设置为 "ABCDE")设置为主机的数据源。如果在模板仪表板上配置该部件,则不支持此参数。 |
|
| 问题 | 1 | problem | 问题的事件名称(不区分大小写,可为完整名称或其中一部分)。 | |
| 严重性 | 0 | severities.0 | 0 - 未分类; 1 - 信息; 2 - 警告; 3 - 一般严重; 4 - 严重; 5 - 灾难。 默认值:空(全部启用)。 注意:要配置多个值,请为每个值创建一个 dashboard 部件字段对象,并在属性名称中使用递增的编号。 |
|
| 问题标签 | ||||
| 评估类型 | 0 | evaltype | 0 - (默认) And/Or; 2 - Or。 |
|
| 标签名称 | 1 | tags.0.tag | 任意字符串值。 注意:属性名称中的数字表示标签评估列表中的标签顺序。 参数行为: - 如果配置了 问题标签,则为 必需 |
|
| 运算符 | 0 | tags.0.operator | 0 - 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在。 注意:属性名称中的数字表示标签评估列表中的标签顺序。 参数行为: - 如果配置了 问题标签,则为 必需 |
|
| 标签值 | 1 | tags.0.value | 任意字符串值。 注意:属性名称中的数字表示标签评估列表中的标签顺序。 参数行为: - 如果配置了 问题标签,则为 必需 |
|
| 显示标签 | 0 | show_tags | 0 - (默认) 无; 1 - 1; 2 - 2; 3 - 3。 |
|
| 标签名称(格式) | 0 | tag_name_format | 0 - (默认) 完整; 1 - 缩写; 2 - 无。 参数行为: - 当 显示标签 设置为 "1"、"2" 或 "3" 时,支持 |
|
| 标签显示优先级 | 1 | tag_priority | 以逗号分隔的标签列表。 参数行为: - 当 显示标签 设置为 "1"、"2" 或 "3" 时,支持 |
|
| 显示运行数据 | 0 | show_opdata | 0 - (默认) 无; 1 - 分开显示; 2 - 与问题名称一起显示。 |
|
| 显示已抑制的问题 | 0 | show_suppressed | 0 - (默认) 禁用; 1 - 启用。 |
|
| 确认状态 | 0 | acknowledgement_status | 0 - (默认) 全部; 1 - 未确认; 2 - 已确认。 |
|
| 由我确认 | 0 | acknowledged_by_me | 0 - (默认) 禁用; 1 - 启用。 |
|
| 条目排序方式 | 0 | sort_triggers | 1 - 严重性(降序); 2 - 主机(升序); 3 - 时间(升序); 4 - (默认) 时间(降序); 13 - 严重性(升序); 14 - 主机(降序); 15 - 问题(升序); 16 - 问题(降序)。 对于除“时间(降序)”和“时间(升序)”之外的所有值,参数 显示时间线 必须设置为“禁用”。 如果在模板仪表板上配置该部件,则不支持“主机(升序)”和“主机(降序)”值。 |
|
| 显示时间线 | 0 | show_timeline | 0 - 禁用; 1 - (默认) 启用。 参数行为: - 当 条目排序方式 设置为“时间(降序)”或“时间(升序)”时,支持 |
|
| 高亮整行 | 0 | highlight_row | 0 - (默认) 禁用; 1 - 启用。 高对比度主题中不支持此参数。 |
|
| 显示行数 | 0 | show_lines | 可能的值范围为 1-100。 默认值:25。 |
|
| Reference | 1 | reference | 由 5 个字符组成的任意字符串值(例如 ABCDE 或 JBPNL)。该值在部件所属的仪表板内必须唯一。参数行为: - 必需 |
|
示例
以下示例仅用于介绍如何在仪表盘组件字段对象中配置 问题 组件。 更多信息,请参考 创建仪表盘。
配置一个问题组件
配置一个问题组件,用于展示主机组 "4" 上满足以下条件的问题:
- 问题存在一个名称为 "scope",值为 "performance" 或 "availability" 或 "capacity" 的标签。
- 问题严重为以下之一:"Warning", "Average", "High", "Disaster"。
此外,设置组件展示标签和操作数据。
请求:
{
"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
}
响应:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}