16 监控项导航器
说明
各个仪表盘组件字段对象中的这些参数和可用属性值允许在dashboard.create
和 dashboard.update
方法中配置监控项导航器组件。
在创建或更新仪表盘期间不会验证组件的 fields
属性。 这个方法允许用户修改内置组件和创建自定义组件,但也会导致存在错误创建或更新组件的风险。 为确保成功创建或更新监控项导航器组件,请参阅下表中概述的参数行为。
参数
监控项导航器组件支持以下参数:
参数 | 类型 | 参数名称 | 参数值或参数说明 | |
---|---|---|---|---|
刷新频率 | 0 | rf_rate | 0 - 不刷新; 10 - 10 秒; 30 - 30 秒; 60 - (默认) 1 分钟; 120 - 2 分钟; 600 - 10 分钟; 900 - 15 分钟。 | |
主机组 | 2 | groupids.0 | 主机组 ID。 注意:如果需要配置多个主机组,则需要给每个主机组创建一个仪表盘组件字段对象,参数名称 groupids.0 中的数字按照顺序进行递增。在仪表盘模板上配置组件时,这个参数不受支持。 | |
主机组 (组件) | 1 | groupids._reference | 用于替代主机组 ID:ABCDE._hostgroupids - 将一个 标识符 参数为 ABCDE 的兼容性组件作为数据源。在仪表盘模板上配置组件时,这个参数不受支持。 | |
主机 | 3 | hostids.0 | 主机 ID。 注意:如果需要配置多个主机,则需要给每个主机创建一个仪表盘组件字段对象,参数名称 hostids.0 中的数字按照顺序进行递增。配置多个主机时,主机组 必须不进行配置或配置中至少包含一个主机所属的主机组。在仪表盘模板上配置组件时,这个参数不受支持。 | |
主机 (组件/仪表盘) | 1 | hostids._reference | 用于替代主机 ID:DASHBOARD.hostid - 将主机选择器作为数据源;ABCDE._hostid - 将一个 标识符 参数为 ABCDE 的兼容性组件作为数据源。在仪表盘模板上配置组件时,这个参数不受支持。 | |
主机标签 | ||||
评估类型 | 0 | host_tags_evaltype | 0 - (默认) And/Or; 2 - Or。 在仪表盘模板上配置组件时,这个参数不受支持。 | |
标签名称 | 1 | host_tags.0.tag | 任意字符串。 注意:参数名称 host_tags.0.tag 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。参数行为: - 必需的 (配置 主机标签 时)。 在仪表盘模板上配置组件时,这个参数不受支持。 | |
操作 | 0 | host_tags.0.operator | 0 - 包含; 1 - 相等; 2 - 不包含; 3 - 不相等; 4 - 存在; 5 - 不存在。 注意:参数名称 host_tags.0.operator 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。参数行为: - 必需的 (配置 主机标签 时)。 在仪表盘模板上配置组件时,这个参数不受支持。 | |
标签值 | 1 | host_tags.0.value | 任意字符串。 注意:参数名称 host_tags.0.value 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。参数行为: - 必需的 (配置 主机标签 时)。 在仪表盘模板上配置组件时,这个参数不受支持。 | |
监控项表达式 | 1 | items.0 | 监控项名称或表达式。 注意:如果需要配置多个监控项表达式,则需要给每个监控项表达式创建一个仪表盘组件字段对象,参数名称 items.0 中的数字按照顺序进行递增。 | |
监控项标签 | ||||
评估类型 | 0 | item_tags_evaltype | 0 - (默认) And/Or; 2 - Or。 | |
标签名称 | 1 | item_tags.0.tag | 任意字符串。 注意:参数名称 item_tags.0.tag 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。参数行为: - 必需的 (配置 监控项标签 时)。 | |
操作 | 0 | item_tags.0.operator | 0 - 包含; 1 - 相等; 2 - 不包含; 3 - 不相等; 4 - 存在; 5 - 不存在。 注意:参数名称 item_tags.0.operator 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。参数行为: - 必需的 (配置 监控项标签 时)。 | |
标签值 | 1 | item_tags.0.value | 任意字符串。 注意:参数名称 item_tags.0.value 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。参数行为: - 必需的 (配置 监控项标签 时)。 | |
状态 | 0 | state | -1 - (默认) 所有; 0 - 正常; 1 - 不支持。 | |
显示问题 | 0 | show_problems | 0 - 所有; 1 - (默认) 未被抑制的; 2 - 无。 | |
分组 | ||||
属性 | 0 | group_by.0.attribute | 0 - 主机组; 1 - 主机名称; 2 - 主机标签值; 3 - 监控项标签值。 注意:参数名称 group_by.0.attribute 中的数字与提供的主机列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。参数行为: - 必需的 (配置 分组 时)。 | |
值 | 1 | group_by.0.tag_name | 任意字符串。 注意:参数名称 group_by.0.tag_name 中的数字需要与 属性 参数中一致。参数行为: - 必需的 (配置 分组 时,如果 属性 被设置为 “主机标签值” 或 “监控项标签值”)。 | |
监控项限制数量 | 0 | show_lines | 可用值范围: 1-9999. 默认值: 100. | |
标识符 | 1 | reference | 任意 5 个英文字符组成的字符串(例如:ABCDE 或 JBPNL )。在这个组件所属的仪表盘中,这个值必须是唯一的。参数行为: - 必需的。 |
示例
以下示例仅用于介绍如何在仪表盘组件字段对象中配置 监控项导航器 组件。 更多信息,请参考 创建仪表盘。
配置一个监控项导航器 组件
配置一个监控项导航器组件,用于展示按照主机分组后再按照标签 “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
}