Documentation
Table of Contents
16 监控项 导航器
描述
这些参数以及相应仪表板 widget 字段 objects 的可能属性值用于配置 在 dashboard.create 和 dashboard.update 方法中的 Item navigator widget。
::: noteimportant 在创建仪表板期间，不会验证Widget fields属性，也不会在仪表板的创建或update期间进行验证。 这允许用户修改built-in widgets和create custom widgets，但也带来了错误创建或更新小部件的风险。 为确保成功创建或update 监控项导航器 小部件，请参考下表中概述的参数行为。 仅返回OutputFormat格式要求结果
参数
以下参数受监控项导航器小部件支持。
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 不刷新； 10 - 10秒； 30 - 30秒； 60 - (默认) 1分钟； 120 - 2分钟； 600 - 10分钟； 900 - 15分钟。 |
|
| 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上配置widget时不支持此参数。 |
|
| Hosts | 3 | hostids.0 | Host ID。 注意：若要配置多个主机，请为每个主机使用递增的属性名编号，create仪表板widget字段object。对于多个主机，主机组参数必须未配置，或至少配置一个包含所配置主机的主机组。 在template dashboard上配置widget时不支持此参数。 |
|
| 主机（小部件/仪表板） | 1 | hostids._reference | 替代Host ID：DASHBOARD.hostid - 将覆盖主机设置为主机的数据源；ABCDE._hostid - 将部件兼容性（其Reference参数设置为"ABCDE"）设置为主机的数据源。在template dashboard上配置widget时不支持此参数。 |
|
| Host tags | ||||
| 评估类型 | 0 | host_tags_evaltype | 0 - (默认) And/Or； 2 - Or。 在template dashboard上配置widget时不支持此参数。 |
|
| 标签名称 | 1 | host_tags.0.tag | 任意string值。 注意：属性名中的数字引用标签评估列表中的标签顺序。 参数行为： - 若配置主机标签则必填 在template dashboard上配置widget时不支持此参数。 |
|
| 运算符 | 0 | host_tags.0.operator | 0 - 包含； 1 - 等于； 2 - 不包含； 3 - 不等于； 4 - 存在； 5 - 不存在。 注意：属性名中的数字引用标签评估列表中的标签顺序。 参数行为： - 若配置主机标签则必填 在template dashboard上配置widget时不支持此参数。 |
|
| 标签值 | 1 | host_tags.0.value | 任意string值。 注意：属性名中的数字引用标签评估列表中的标签顺序。 参数行为： - 若配置主机标签则必填 在template dashboard上配置widget时不支持此参数。 |
|
| Item patterns | 1 | items.0 | Item名称或模式。 注意：若要配置多个监控项模式，请为每个监控项模式使用递增的属性名编号，create仪表板widget字段object。 |
|
| Item tags | ||||
| 评估类型 | 0 | item_tags_evaltype | 0 - (默认) And/Or； 2 - Or。 |
|
| 标签名称 | 1 | item_tags.0.tag | 任意string值。 注意：属性名中的数字引用标签评估列表中的标签顺序。 参数行为： - 若配置监控项标签则必填 |
|
| 运算符 | 0 | item_tags.0.operator | 0 - 包含； 1 - 等于； 2 - 不包含； 3 - 不等于； 4 - 存在； 5 - 不存在。 注意：属性名中的数字引用标签评估列表中的标签顺序。 参数行为： - 若配置监控项标签则必填 |
|
| 标签值 | 1 | item_tags.0.value | 任意string值。 注意：属性名中的数字引用标签评估列表中的标签顺序。 参数行为： - 若配置监控项标签则必填 |
|
| State | 0 | state | -1 - (默认) 所有； 0 - 正常； 1 - 不支持。 |
|
| Show problems | 0 | show_problems | 0 - 所有； 1 - (默认) 未抑制； 2 - 无。 |
|
| Group by | ||||
| 属性 | 0 | group_by.0.attribute | 0 - 主机组； 1 - 主机名； 2 - 主机标签值； 3 - 监控项标签值。 注意：属性名中的数字引用分组属性列表中的属性顺序。 参数行为： - 若配置按...分组则必填 |
|
| 值 | 1 | group_by.0.tag_name | 任意string值。 注意：属性名中的数字引用在属性参数中设置的分组属性。 参数行为： - 若配置按...分组且属性设置为"主机标签值"或"监控项标签值"则必填 |
|
| Item limit | 0 | show_lines | 可能值范围为1-9999。 默认值：100。 |
|
| Reference | 1 | reference | 由5字符组成的任意string值（例如，ABCDE或JBPNL）。此值在widget所属的仪表板中必须唯一。参数行为： - 必填 |
|
示例
以下示例仅用于描述如何为 监控项 导航器 小组件配置仪表板 widget 字段 objects。 有关配置仪表板的更多信息，请参见 dashboard.create。
配置 监控项 导航器 小部件
配置一个监控项导航器小部件get，用于显示最多1000个监控项，按其主机分组，然后按"component"监控项标签值进行细分。
执行请求:
{
"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
}响应：