17 监控项导航器

说明

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

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

参数

以下参数适用于 监控项导航器 部件。

参数 type name value
刷新间隔 0 rf_rate 0 - 不刷新;
10 - 10 秒;
30 - 30 秒;
60 - (默认) 1 分钟;
120 - 2 分钟;
600 - 10 分钟;
900 - 15 分钟。
主机组 2 groupids.0 主机组 ID。

注意:要配置多个主机组,请为每个主机组创建一个 dashboard widget field 对象,并在属性名称中使用递增的编号。

如果在模板仪表板上配置该部件,则不支持此参数。
主机组(部件) 1 groupids._reference 用于代替主机组 ID:
ABCDE._hostgroupids - 将兼容部件(其 Reference 参数设置为 "ABCDE")设置为主机组的数据源。

如果在模板仪表板上配置该部件,则不支持此参数。
主机 3 hostids.0 主机 ID。

注意:要配置多个主机,请为每个主机创建一个 dashboard widget field 对象,并在属性名称中使用递增的编号。对于多个主机,参数 主机组 必须要么完全不配置,要么至少配置一个已配置主机所属的主机组。

如果在模板仪表板上配置该部件,则不支持此参数。
主机(部件/仪表板) 1 hostids._reference 用于代替主机 ID:
DASHBOARD.hostid - 将仪表板主机选择器设置为主机的数据源;
ABCDE._hostid - 将兼容部件(其 Reference 参数设置为 "ABCDE")设置为主机的数据源。

如果在模板仪表板上配置该部件,则不支持此参数。
主机标签
评估类型 0 host_tags_evaltype 0 - (默认) And/Or;
2 - Or。

如果在模板仪表板上配置该部件,则不支持此参数。
标签名称 1 host_tags.0.tag 任意字符串值。

注意:属性名称中的数字表示标签评估列表中的标签顺序。

参数行为
- 如果配置了 主机标签,则为 必需

如果在模板仪表板上配置该部件,则不支持此参数。
运算符 0 host_tags.0.operator 0 - 包含;
1 - 等于;
2 - 不包含;
3 - 不等于;
4 - 存在;
5 - 不存在。

注意:属性名称中的数字表示标签评估列表中的标签顺序。

参数行为
- 如果配置了 主机标签,则为 必需

如果在模板仪表板上配置该部件,则不支持此参数。
标签值 1 host_tags.0.value 任意字符串值。

注意:属性名称中的数字表示标签评估列表中的标签顺序。

参数行为
- 如果配置了 主机标签,则为 必需

如果在模板仪表板上配置该部件,则不支持此参数。
监控项模式 1 items.0 监控项名称或模式。

注意:要配置多个监控项模式,请为每个监控项模式创建一个 dashboard widget field 对象,并在属性名称中使用递增的编号。
监控项标签
评估类型 0 item_tags_evaltype 0 - (默认) And/Or;
2 - Or。
标签名称 1 item_tags.0.tag 任意字符串值。

注意:属性名称中的数字表示标签评估列表中的标签顺序。

参数行为
- 如果配置了 监控项标签,则为 必需
运算符 0 item_tags.0.operator 0 - 包含;
1 - 等于;
2 - 不包含;
3 - 不等于;
4 - 存在;
5 - 不存在。

注意:属性名称中的数字表示标签评估列表中的标签顺序。

参数行为
- 如果配置了 监控项标签,则为 必需
标签值 1 item_tags.0.value 任意字符串值。

注意:属性名称中的数字表示标签评估列表中的标签顺序。

参数行为
- 如果配置了 监控项标签,则为 必需
状态 0 state -1 - (默认) 全部;
0 - 正常;
1 - 不支持。
显示问题 0 show_problems 0 - 全部;
1 - (默认) 未抑制;
2 - 无。
分组依据
属性 0 group_by.0.attribute 0 - 主机组;
1 - 主机名称;
2 - 主机标签值;
3 - 监控项标签值。

注意:属性名称中的数字表示分组属性列表中的属性顺序。

参数行为
- 如果配置了 分组依据,则为 必需
1 group_by.0.tag_name 任意字符串值。

注意:属性名称中的数字表示在 属性 参数中设置的分组属性。

参数行为
- 如果配置了 分组依据属性 设置为“主机标签值”或“监控项标签值”,则为 必需
监控项限制 0 show_lines 可能的值范围为 1-9999。

默认值:100。
Reference 1 reference 由 5 个字符组成的任意字符串值(例如 ABCDEJBPNL)。该值在该部件所属的仪表板内必须唯一。

参数行为
- 必需

示例

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

配置一个监控项导航器 组件

配置一个监控项导航器组件,用于展示按照主机分组后再按照标签 "component" 的值分组的 1000 个监控项。

请求:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": "30",
        "auto_start": "1",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "itemnavigator",
                        "name": "Item navigator",
                        "x": "0",
                        "y": "0",
                        "width": "12",
                        "height": "5",
                        "view_mode": "0",
                        "fields": [
                            {
                                "type": 0,
                                "name": "group_by.0.attribute",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "group_by.1.attribute",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "group_by.1.tag_name",
                                "value": "component"
                            },
                            {
                                "type": 0,
                                "name": "show_lines",
                                "value": 1000
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "DFNLK"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

响应:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

参考