28 个热门监控项
描述
这些参数以及相应 dashboard widget 字段对象的可选属性值，可用于在 dashboard.create 和 dashboard.update 方法中配置 Top items widget。
在创建或更新 dashboard 时，不会对 widget fields 属性进行验证。
这使用户能够修改 内置 widget 并创建 自定义 widget，但也会带来错误创建或更新 widget 的风险。
为确保成功创建或更新 Top items widget，请参阅下方表格中概述的参数行为。
参数
以下参数适用于 Top items 小组件。
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 不刷新； 10 - 10 秒； 30 - 30 秒； 60 - (默认) 1 分钟； 120 - 2 分钟； 600 - 10 分钟； 900 - 15 分钟。 |
|
| Host groups | 2 | groupids.0 | 主机组 ID。 注意：要配置多个主机组，请为每个主机组创建一个 dashboard 小组件字段对象，并在属性名中递增编号。 如果在 模板 dashboard 上配置该小组件，则不支持此参数。 |
|
| Host groups (Widget) | 1 | groupids._reference | 不使用 主机组 ID，而是：ABCDE._hostgroupids - 将一个 兼容小组件（其 Reference 参数设置为 "ABCDE"）设为主机组的数据源。如果在 模板 dashboard 上配置该小组件，则不支持此参数。 |
|
| Hosts | 3 | hostids.0 | 主机 ID。 注意：要配置多个主机，请为每个主机创建一个 dashboard 小组件字段对象，并在属性名中递增编号。对于多个主机，参数 Host groups 必须完全不配置，或者至少配置一个这些主机所属的主机组。 如果在 模板 dashboard 上配置该小组件，则不支持此参数。 |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | 不使用 主机 ID，而是：DASHBOARD.hostids - 将 Host 选择器 设为主机的数据源；ABCDE._hostids - 将一个 兼容小组件（其 Reference 参数设置为 "ABCDE"）设为主机的数据源。如果在 模板 dashboard 上配置该小组件，则不支持此参数。 |
|
| Host tags | ||||
| Evaluation type | 0 | host_tags_evaltype | 0 - (默认) And/Or； 2 - Or。 如果在 模板 dashboard 上配置该小组件，则不支持此参数。 |
|
| Tag name | 1 | host_tags.0.tag | 任意字符串值。 注意：属性名中的数字表示标签评估列表中的标签顺序。 参数行为： - 如果配置 Host tags，则为必填 如果在 模板 dashboard 上配置该小组件，则不支持此参数。 |
|
| Operator | 0 | host_tags.0.operator | 0 - 包含； 1 - 等于； 2 - 不包含； 3 - 不等于； 4 - 存在； 5 - 不存在。 注意：属性名中的数字表示标签评估列表中的标签顺序。 参数行为： - 如果配置 Host tags，则为必填 如果在 模板 dashboard 上配置该小组件，则不支持此参数。 |
|
| Tag value | 1 | host_tags.0.value | 任意字符串值。 注意：属性名中的数字表示标签评估列表中的标签顺序。 参数行为： - 如果配置 Host tags，则为必填 如果在 模板 dashboard 上配置该小组件，则不支持此参数。 |
|
| Layout | 0 | layout | 0 - (默认) 水平； 1 - 垂直。 |
|
| Show problems | 0 | show_problems | 0 - 全部； 1 - (默认) 未抑制； 2 - 无。 |
|
| Items (see below) | ||||
高级配置
以下高级配置参数适用于监控项小组件。
| 参数 | 类型 | 名称 | 值 | |
|---|---|---|---|---|
| 主机排序 | ||||
| 排序依据 | 0 | host_ordering_order_by | 0 - （默认） 主机名称； 3 - 监控项值。 |
|
| 监控项模式 | 1 | host_ordering_item.0 | 监控项名称或模式（例如："*: 每秒处理的*值数量"）。 注意：要配置多个监控项模式，请为每个监控项模式创建一个小组件字段对象，并在属性名称中使用递增的编号。 在模板仪表板上配置小组件时，只应设置模板上已配置监控项的模式。 参数行为： - 当排序依据设置为“监控项值”时为必需 |
|
| 顺序 | 0 | host_ordering_order | 2 - （默认） 前 N 项； 3 - 后 N 项。 |
|
| 限制 | 0 | host_ordering_limit | 可能值范围为 1 至 100。 默认值：10。 |
|
| 监控项排序 | ||||
| 排序依据 | 0 | item_ordering_order_by | 1 - 主机； 2 - 监控项名称； 3 - （默认） 监控项值。 |
|
| 主机模式 | 1 | item_ordering_host.0 | 主机名称或模式。 注意：要配置多个主机模式，请为每个主机模式创建一个小组件字段对象，并在属性名称中使用递增的编号。 参数行为： - 当排序依据设置为“主机”时为必需 |
|
| 顺序 | 0 | item_ordering_order | 2 - （默认） 前 N 项； 3 - 后 N 项。 |
|
| 限制 | 0 | item_ordering_limit | 可能值范围为 1 至 100。 默认值：10。 |
|
列
属性名称中的第一个数字（例如 columns.0.items.0、columns.0.item_tags_evaltype）表示特定列；如果存在第二个数字，则表示已配置的实体（例如监控项模式、标签）。
| 参数 | 类型 | 名称 | 值 | |
|---|---|---|---|---|
| 监控项模式 | 1 | columns.0.items.0 | 监控项名称或模式（例如，“*: 每秒处理的 *值数量”）。 注意：要配置多个监控项模式，请为每个监控项模式创建一个仪表板小组件字段对象，并在属性名称中递增第二个数字。 在模板仪表板上配置小组件时，只应设置模板上配置的监控项模式。 参数行为： - 必需 |
|
| 监控项标签 | ||||
| 评估类型 | 0 | columns.0.item_tags_evaltype | 0 - （默认） And/Or； 2 - Or。 |
|
| 标签名称 | 1 | columns.0.item_tags.0.tag | 任意字符串值。 注意：属性名称中的第二个数字表示标签评估列表中的标签顺序。 参数行为： - 配置监控项标签时为必需 |
|
| 运算符 | 0 | columns.0.item_tags.0.operator | 0 - 包含； 1 - 等于； 2 - 不包含； 3 - 不等于； 4 - 存在； 5 - 不存在。 注意：属性名称中的第二个数字表示标签评估列表中的标签顺序。 参数行为： - 配置监控项标签时为必需 |
|
| 标签值 | 1 | columns.0.item_tags.0.value | 任意字符串值。 注意：属性名称中的第二个数字表示标签评估列表中的标签顺序。 参数行为： - 配置监控项标签时为必需 |
|
| 基础颜色 | 1 | columns.0.base_color | 十六进制颜色代码（例如 FF0000）。 |
|
| 将值显示为 | 0 | columns.0.display_value_as | 1 - （默认） 数值； 2 - 文本。 |
|
| 显示 | 0 | columns.0.display | 1 - （默认） 原样； 2 - 条形图； 3 - 指示器； 6 - 迷你图。 |
|
| 最小值 | 1 | columns.0.min | 任意数值。后缀（例如“1d”、“2w”、“4K”、“8G”）受支持。 参数行为： - 当将值显示为设置为“数值”，且显示设置为“条形图”或“指示器”时支持 |
|
| 最大值 | 1 | columns.0.max | 任意数值。后缀（例如“1d”、“2w”、“4K”、“8G”）受支持。 参数行为： - 当将值显示为设置为“数值”，且显示设置为“条形图”或“指示器”时支持 |
|
| 迷你图 | ||||
| 宽度 | 0 | columns.0.sparkline.width | 可能值范围为 0 到 10。 默认值：1。 参数行为： - 当显示设置为“迷你图”时支持 |
|
| 填充 | 0 | columns.0.sparkline.fill | 可能值范围为 0 到 10。 默认值：3。 参数行为： - 当显示设置为“迷你图”时支持 |
|
| 颜色 | 1 | columns.0.sparkline.color | 十六进制颜色代码（例如 FF0000）。默认值： 42A5F5。参数行为： - 当显示设置为“迷你图”时支持 |
|
| 时间段 | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - 将“时间段”选择器设置为数据源；ABCDE._timeperiod - 将兼容的小组件（其 reference 参数等于 ABCDE）设置为数据源。默认值： DASHBOARD._timeperiod或者，也可以仅在起始时间和结束时间参数中设置时间段。 参数行为： - 当显示设置为“迷你图”时支持 |
|
| 起始时间 | 1 | columns.0.sparkline.time_period.from | 绝对时间格式（YYYY-MM-DD hh:mm:ss）或相对时间语法（now、now/d、now/w-1w 等）中的有效时间字符串。参数行为： - 当显示设置为“迷你图”时支持 - 如果设置了 columns.0.sparkline.time_period.to，则为必需 |
|
| 结束时间 | 1 | columns.0.sparkline.time_period.to | 绝对时间格式（YYYY-MM-DD hh:mm:ss）或相对时间语法（now、now/d、now/w-1w 等）中的有效时间字符串。参数行为： - 当显示设置为“迷你图”时支持 - 如果设置了 columns.0.sparkline.time_period.from，则为必需 |
|
| 历史数据 | 0 | columns.0.sparkline.history | 0 - （默认） 自动； 1 - 历史数据； 2 - 趋势。 参数行为： - 当显示设置为“迷你图”时支持 |
|
| 阈值 | ||||
| 颜色 | 1 | columns.0.thresholds.0.color | 十六进制颜色代码（例如 FF0000）。参数行为： - 当将值显示为设置为“数值”时支持 |
|
| 阈值 | 1 | columns.0.thresholds.0.threshold | 任意数值。后缀（例如“1d”、“2w”、“4K”、“8G”）受支持。 参数行为： - 当将值显示为设置为“数值”时支持 |
|
| 高亮 | ||||
| 高亮 | 1 | columns.0.highlights.0.color | 十六进制颜色代码（例如 FF0000）。参数行为： - 当将值显示为设置为“文本”时支持 |
|
| 阈值 | 1 | columns.0.highlights.0.pattern | 任意正则表达式。 参数行为： - 当将值显示为设置为“文本”时支持 |
|
| 小数位数 | 0 | columns.0.decimal_places | 可能值范围为 0 到 10。 默认值：2。 |
|
| 高级配置 | ||||
| 聚合函数 | 0 | columns.0.aggregate_function | 如果将值显示为设置为“数值”： 0 - （默认） 不使用； 1 - 最小值； 2 - 最大值； 3 - 平均值； 4 - 计数； 5 - 总和； 6 - 第一个； 7 - 最后一个。 如果将值显示为设置为“文本”： 0 - （默认） 不使用； 4 - 计数； 6 - 第一个； 7 - 最后一个。 |
|
| 时间段 | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - 将“时间段”选择器设置为数据源；ABCDE._timeperiod - 将兼容的小组件（其 reference 参数等于 ABCDE）设置为数据源。默认值： DASHBOARD._timeperiod或者，也可以仅在起始时间和结束时间参数中设置时间段。 参数行为： - 当聚合函数设置为“最小值”、“最大值”、“平均值”、“计数”、“总和”、“第一个”或“最后一个”时支持 |
|
| 起始时间 | 1 | columns.0.time_period.from | 绝对时间格式（YYYY-MM-DD hh:mm:ss）或相对时间语法（now、now/d、now/w-1w 等）中的有效时间字符串。参数行为： - 当未设置时间段且聚合函数设置为“最小值”、“最大值”、“平均值”、“计数”、“总和”、“第一个”或“最后一个”时支持 - 如果设置了 columns.0.time_period.to，则为必需 |
|
| 结束时间 | 1 | columns.0.time_period.to | 绝对时间格式（YYYY-MM-DD hh:mm:ss）或相对时间语法（now、now/d、now/w-1w 等）中的有效时间字符串。参数行为： - 当未设置时间段且聚合函数设置为“最小值”、“最大值”、“平均值”、“计数”、“总和”、“第一个”或“最后一个”时支持 - 如果设置了 columns.0.time_period.from，则为必需 |
|
| 历史数据 | 0 | columns.0.history | 0 - （默认） 自动； 1 - 历史数据； 2 - 趋势。 参数行为： - 当将值显示为设置为“数值”时支持 |
|
示例
以下示例仅用于说明 Top items 小部件的仪表板小部件字段对象配置。
有关如何配置仪表板的更多信息，请参见 dashboard.create。
配置 Top items 小部件
配置一个 Top items 小部件，使其显示主机“10084”的数据，并且仅显示标签名称为“component”且其值包含“cpu”的监控项。 此外，以主机位于顶部的方式显示数据，并使用彩色仪表条来表示单元格。
请求：
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "topitems",
"name": "Top items",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "columns.0.items.0",
"value": "*"
},
{
"type": 1,
"name": "columns.0.item_tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "columns.0.item_tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "columns.0.item_tags.0.value",
"value": "cpu"
},
{
"type": 0,
"name": "columns.0.display",
"value": 2
},
{
"type": 0,
"name": "layout",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}