Documentation
26 TOP主机
说明
各个仪表盘组件字段对象中的这些参数和可用属性值允许在dashboard.create 和 dashboard.update 方法中配置TOP主机组件
在创建或更新仪表盘期间不会验证组件的 fields 属性。 这个方法允许用户修改内置组件和创建自定义组件，但也会导致存在错误创建或更新组件的风险。 为确保成功创建或更新TOP主机组件，请参阅下表中概述的参数行为。
参数
TOP主机组件支持以下参数：
| 参数 | 类型 | 参数名称 | 参数值或参数说明 | |
|---|---|---|---|---|
| 刷新频率 | 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 - 将一个 Reference 参数为 ABCDE 的兼容性组件作为数据源在仪表盘模板上配置组件时，这个参数不受支持。 |
|
| 主机 | 3 | hostids.0 | 主机 ID. 注意：如果需要配置多个主机，则需要给每个主机创建一个仪表盘组件字段对象，参数名称 hostids.0 中的数字按照顺序进行递增。配置多个主机时，主机组 必须不进行配置或配置中至少包含一个主机所属的主机组。在仪表盘模板上配置组件时，这个参数不受支持。 |
|
| 主机 (组件/仪表盘) | 1 | hostids._reference | 用于替代主机 ID:DASHBOARD.hostids - 将主机选择器作为数据源。ABCDE._hostids - 将一个 Reference 参数为 ABCDE 的兼容性组件作为数据源在仪表盘模板上配置组件时，这个参数不受支持。 |
|
| 主机标签 | ||||
| 评估类型 | 0 | evaltype | 0 - (默认) And/Or; 2 - Or. 在仪表盘模板上配置组件时，这个参数不受支持。 |
|
| 标签名称 | 1 | tags.0.tag | 任意字符串。 注意：参数名称 tags.0.value 中的数字与提供的参数列表需要一致，例如，总数为 3，则下标参数名称中的数字分别为：0, 1, 2。参数行为: - 必需的 (配置 主机标签 时) 在仪表盘模板上配置组件时，这个参数不受支持。 |
|
| 操作 | 0 | tags.0.operator | 0 - 包含; 1 - 相等; 2 - 不包含; 3 - 不相等; 4 - 存在; 5 - 不存在 注意：参数名称 tags.0.value 中的数字与提供的参数列表需要一致，例如，总数为 3，则下标参数名称中的数字分别为：0, 1, 2。参数行为: - 必需的 (配置 主机标签 时) 在仪表盘模板上配置组件时，这个参数不受支持。 |
|
| 标签值 | 1 | tags.0.value | 任意字符串。 注意：参数名称 tags.0.value 中的数字与提供的参数列表需要一致，例如，总数为 3，则下标参数名称中的数字分别为：0, 1, 2。参数行为: - 必需的 (配置 主机标签 时) 在仪表盘模板上配置组件时，这个参数不受支持。 |
|
| 显示维护中的主机 | 0 | maintenance | 0 - (默认) 禁用; 1 - 启用. |
|
| 列 (请看下面) | ||||
| 排序 | 0 | column | 已配置的列的序号。比如总共配置了 3 列，若需要通过第二列进行排序，则此处就是下标 1(下标从 0 开始) | |
| 排序 | 0 | order | 2 - (默认) Top N; 3 - Bottom N. |
|
| 主机限制数量 | 0 | show_lines | 可用值范围： 1-100. 默认值： 10. 在仪表盘模板上配置组件时，这个参数不受支持。 |
|
列
列有公共参数，也有由 数据 参数配置确定的额外参数。
所有列相关的参数中的数字 (例如：columns.0.name) 依赖于配置在哪一列。示例中代表配置第一列。
所有列均支持以下参数：
| 参数 | 类型 | 参数名称 | 参数值或参数说明 |
|---|---|---|---|
| 名称 | 1 | columns.0.name | 任意字符串。 参数行为: - 必需的 |
| 数据 | 0 | columns.0.data | 1 - 监控项值; 2 - 主机名称; 3 - 文本. 参数行为: - 必需的 |
| 颜色 | 1 | columns.0.base_color | 十六进制颜色代码(例如：FF0000)。参数行为: - 必需的 |
监控项值
当 数据 设置为 "监控项值" 时，支持以下参数。
Thresholds 属性名称中的第一个数字 (例如：columnsthresholds.0.color.0) 依赖于配置在哪一列。示例中代表配置第一列。 第二个数字与提供的参数列表需要一致，且升序排序。例如，总数为 3，则下标参数名称中的数字分别为：0, 1, 2。 如果传入的数字未按照升序排序，则 Zabbix 前端更新组件时会自动按照升序排序。(例如："threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1.threshold": "5").
| 参数 | 类型 | 参数名称 | 参数值或参数说明 | |
|---|---|---|---|---|
| 监控项 | 1 | columns.0.item | 有效监控项名称 如果是在仪表盘模板上配置组件，则仅允许设置仪表盘模板上存在的监控项。 |
|
| 显示 | 0 | columns.0.display | 1 - (默认) 原样展示; 2 - 条形; 3 - 指标. |
|
| 最小值 | 1 | columns.0.min | 任意数值 参数行为: - 支持 (如果 显示 配置为 "条形" 或 "指标") |
|
| 最大值 | 1 | columns.0.max | 任意数值 参数行为: - 支持 (如果 显示 配置为 "条形" 或 "指标") |
|
| 小数位数 | 0 | columns.0.decimal_places | 可用值范围： 0-10. 默认值： 2. |
|
| 阈值 | ||||
| 颜色 | 1 | columnsthresholds.0.color.0 | 十六进制颜色代码(例如：FF0000)。默认值： "" (空). |
|
| 阈值 | 1 | columnsthresholds.0.threshold.0 | 任意字符串。 | |
| 聚合函数 | 0 | columns.0.aggregate_function | 0 - (默认) not used; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| 时间期间 | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - 将时间期间选择器选择器作为数据源ABCDE._timeperiod - 将一个 Reference 参数为 ABCDE 的兼容性组件作为数据源默认值： DASHBOARD._timeperiod另外，你也可以仅仅通过 From 和 To 参数指定时间周期。 参数行为: - 支持 (如果 聚合函数 配置为 "min", "max", "avg", "count", "sum", "first", "last") |
|
| From | 1 | columns.0.time_period.from | 绝对(YYYY-MM-DD hh:mm:ss)或相对(now, now/d, now/w-1w等)时间字符串。参数行为: - 支持 (如果 时间期间 未设置且 聚合函数 配置为 "min", "max", "avg", "count", "sum", "first", "last") |
|
| To | 1 | columns.0.time_period.to | 绝对(YYYY-MM-DD hh:mm:ss)或相对(now, now/d, now/w-1w等)时间字符串。参数行为: - 支持 (如果 时间期间 未设置且 聚合函数 配置为 "min", "max", "avg", "count", "sum", "first", "last") |
|
| 历史数据 | 0 | columns.0.history | 0 - (默认) 自动; 1 - 历史; 2 - 趋势. |
|
| Reference | 1 | reference | 任意 5 个英文字符组成的字符串(例如：ABCDE 或 JBPNL)。在这个组件所属的仪表盘中，这个值必须是唯一的。参数行为: - 必需的 |
|
文本
当 数据 设置为 "文本" 时，支持以下参数：
| 参数 | 类型 | 参数名称 | 参数值或参数说明 |
|---|---|---|---|
| 文本 | 1 | columns.0.text | 任意字符串，包含宏变量 支持的宏变量如下：{HOST.*}, {INVENTORY.*}. 参数行为: - 必需的 (如果 数据 设置为 "文本") |
示例
以下示例仅用于介绍如何在仪表盘组件字段对象中配置 TOP主机 组件。 更多信息，请参考 dashboard.create
配置一个TOP主机组件
配置一个TOP主机组件，用于展示主机组 "4" 中 CPU 利用率的 TOP 主机。 同时配置如下列："Host name", "CPU utilization in %", "1m avg", "5m avg", "15m avg", "Processes"
请求:
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "tophosts",
"name": "Top hosts",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 1,
"name": "columns.0.name",
"value": "Host"
},
{
"type": 0,
"name": "columns.0.data",
"value": 2
},
{
"type": 1,
"name": "columns.0.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.1.name",
"value": "CPU utilization in %"
},
{
"type": 0,
"name": "columns.1.data",
"value": 1
},
{
"type": 1,
"name": "columns.1.base_color",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.1.item",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.1.display",
"value": 3
},
{
"type": 1,
"name": "columns.1.min",
"value": "0"
},
{
"type": 1,
"name": "columns.1.max",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.1.color.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.1.color.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.1.color.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.2",
"value": "90"
},
{
"type": 1,
"name": "columns.2.name",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.2.data",
"value": 1
},
{
"type": 1,
"name": "columns.2.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.2.item",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.3.name",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.3.data",
"value": 1
},
{
"type": 1,
"name": "columns.3.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.3.item",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.4.name",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.4.data",
"value": 1
},
{
"type": 1,
"name": "columns.4.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.4.item",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.5.name",
"value": "Processes"
},
{
"type": 0,
"name": "columns.5.data",
"value": 1
},
{
"type": 1,
"name": "columns.5.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.5.item",
"value": "Number of processes"
},
{
"type": 0,
"name": "columns.5.decimal_places",
"value": 0
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}响应：