22 问题

说明

各个仪表盘组件字段对象中的这些参数和可用属性值允许在dashboard.createdashboard.update 方法中配置问题组件。

在创建或更新仪表盘期间不会验证组件的 fields 属性。 这个方法允许用户修改内置组件和创建自定义组件,但也会导致存在错误创建或更新组件的风险。 为确保成功创建或更新问题组件,请参阅下表中概述的参数行为。

参数

问题组件支持以下参数:

参数 类型 参数名称 参数值或参数说明
刷新频率 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。

注意:如果需要配置多个主机组,则需要给每个主机组创建一个仪表盘组件字段对象,参数名称 groupids.0 中的数字按照顺序进行递增。

仪表盘模板上配置组件时,这个参数不受支持。
主机组 (组件) 1 groupids._reference 用于替代主机组 ID:
ABCDE._hostgroupids - 将一个 标识符 参数为 ABCDE兼容性组件作为数据源。

仪表盘模板上配置组件时,这个参数不受支持。
排除主机组 2 exclude_groupids.0 主机组 ID。

注意:如果需要排除多个主机组,则需要给每个主机组创建一个仪表盘组件字段对象,参数名称 exclude_groupids.0 中的数字按照顺序进行递增。

仪表盘模板上配置组件时,这个参数不受支持。
主机 3 hostids.0 主机 ID。

注意:如果需要配置多个主机,则需要给每个主机创建一个仪表盘组件字段对象,参数名称 hostids.0 中的数字按照顺序进行递增。配置多个主机时,主机组 必须不进行配置或配置中至少包含一个主机所属的主机组。

仪表盘模板上配置组件时,这个参数不受支持。
主机 (组件/仪表盘) 1 hostids._reference 用于替代主机 ID:
DASHBOARD.hostids - 将主机选择器作为数据源;
ABCDE._hostids - 将一个 标识符 参数为 ABCDE兼容性组件作为数据源。

仪表盘模板上配置组件时,这个参数不受支持。
问题 1 problem 问题 事件名称 (不区分大小写,全名或部分名称)。
严重性 0 severities.0 0 - 未定义;
1 - 信息;
2 - 警告;
3 - 一般;
4 - 严重;
5 - 灾难。

默认值:空 (全部启用)。

注意:如果需要配置多个值,则需要给每个值创建一个仪表盘组件字段对象,参数名称 severities.0 中的数字按照顺序进行递增。
问题标签
评估类型 0 evaltype 0 - (默认) And/Or;
2 - Or。
标签名称 1 tags.0.tag 任意字符串。

注意:参数名称 tags.0.tag 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。

参数行为
- 必需的 (配置 问题标签 时)。
操作 0 tags.0.operator 0 - 包含;
1 - 相等;
2 - 不包含;
3 - 不相等;
4 - 存在;
5 - 不存在。

注意:参数名称 tags.0.operator 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。

参数行为
- 必需的 (配置 问题标签 时)。
标签值 1 tags.0.value 任意字符串。

注意:参数名称 tags.0.value 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。

参数行为
- 必需的 (配置 问题标签 时)。
显示标签 0 show_tags 0 - (默认) None;
1 - 1;
2 - 2;
3 - 3。
标签名称 (格式) 0 tag_name_format 0 - (默认) Full;
1 - Shortened;
2 - None。

参数行为
- 支持 (如果 显示标签 设置为 "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 - 已确认。
By me 0 acknowledged_by_me 0 - (默认) 禁用;
1 - 启用。
排序类型 0 sort_triggers 1 - 严重性 (倒序);
2 - 主机 (升序);
3 - 时间 (升序);
4 - (默认) 时间 (倒序);
13 - 严重性 (升序);
14 - 主机 (倒序);
15 - 问题 (升序);
16 - 问题 (倒序)。

除 "时间 (倒序)" 和 "时间 (升序)" 外,显示时间线 必须设置为 "禁用"。

仪表盘模板上配置组件时 "主机 (升序)" 和 "主机 (倒序)" 不支持。
显示时间线 0 show_timeline 0 - 禁用;
1 - (默认) 启用。

参数行为
- 支持 (如果 排序类型 设置为 "时间 (倒序)" 或 "时间 (升序)")。
显示行数 0 show_lines 可用值范围:1-100。

默认值:25。
标识符 1 reference 任意 5 个英文字符组成的字符串(例如:ABCDEJBPNL)。在这个组件所属的仪表盘中,这个值必须是唯一的。

参数行为
- 必需的

示例

以下示例仅用于介绍如何在仪表盘组件字段对象中配置 问题 组件。 更多信息,请参考 创建仪表盘

配置一个问题组件

配置一个问题组件,用于展示主机组 "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
       }

参考