Documentation
26 Top 主机
描述
这些参数及对应仪表板小组件字段objects的可选属性值，可用于在dashboard.create和dashboard.update方法中配置Top hosts小组件。
仪表板创建或update过程中不会验证fields小组件的属性。这使得用户可以修改built-in widgets和createcustom widgets，但也存在错误创建或更新小组件的风险。为确保成功创建或updateTop 主机小组件，请参考下表中列出的参数行为说明。
参数
以下参数受Top 主机小部件支持。
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| 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上配置小get，则不支持此参数。 |
|
| Hosts | 3 | hostids.0 | Host ID。 注意：要配置多个 主机，请 create 为每个 主机 添加一个仪表板 widget 字段 object，并在属性名称中使用递增的编号。对于多个 主机，参数 主机 组 必须要么完全不配置，要么至少配置一个 主机组，所配置的 主机 必须属于该组。 如果在 template dashboard 上配置 widget，则不支持此参数。 |
|
| 主机（Widget/Dashboard） | 1 | hostids._reference | 请不要使用Host ID：DASHBOARD.hostids - 将覆盖主机设置为主机的数据源；ABCDE._hostids - 将一个部件兼容性（将其Reference参数设置为"ABCDE"）设置为主机的数据源。如果在template dashboard上配置widget，则不支持此参数。 |
|
| Host tags | ||||
| 评估类型 | 0 | evaltype | 0 - (默认) And/Or; 2 - Or。 如果在template dashboard上配置widget，则不支持此参数。 |
|
| 标签名称 | 1 | tags.0.tag | 任意 string 值。 注意：属性名称中的数字表示标签评估列表中的标签顺序。 参数行为: - 在配置 主机 标签 时为必填项 在配置 template dashboard 上的 widget 时，不支持此参数。 |
|
| 操作符 | 0 | tags.0.operator | 0 - 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在。 注意：属性名称中的数字引用标签评估列表中的标签顺序。 参数行为: - 如果配置主机标签，则为必填 如果在template dashboard上配置widget，则不支持此参数。 |
|
| 标签值 | 1 | tags.0.value | 任意 string 值。 注意：属性名称中的数字表示标签评估列表中的标签顺序。 参数行为: - 在配置 主机 标签 时为必填项 在配置 widget 于 template dashboard 上时不支持此参数。 |
|
| Show hosts in maintenance | 0 | maintenance | 0 - (默认) 已禁用； 1 - 已启用。 |
|
| Columns (see below) | ||||
| Order by | 0 | column | 从配置列中获取的列数值。 | |
| Order | 0 | order | 2 - (默认) Top N; 3 - 最低 N。 |
|
| Host limit | 0 | show_lines | 可能的取值范围为 1-100。 默认值：10。 如果在 template dashboard 上配置 widget，则不支持此参数。 |
|
列
列具有根据参数数据的配置而定的通用参数和附加参数。
对于与列相关的所有参数，属性名称中的数字（例如 columns.0.name）表示为其配置参数的列。
以下参数适用于所有列。
| 参数 | 仪表板小部件字段 | 名称 | 值 |
|---|---|---|---|
| Name | 1 | columns.0.name | 任意 string 值。 参数行为: - 必填 |
| Data | 0 | columns.0.data | 1 - 监控项 值； 2 - 主机名； 3 - 文本。 参数行为: - 必填 |
| Base color | 1 | columns.0.base_color | 十六进制颜色代码（例如 FF0000）。参数行为: - 必填 |
监控项值
如果将 Data 设置为 "监控项 value"，则支持以下参数。
Thresholds 属性名称中的第一个数字（例如 columnsthresholds.0.color.0）引用为其配置阈值的列， 第二个数字引用列表中阈值的位置，按升序排列。 但是，如果以不同的顺序配置阈值，在 Zabbix 前端更新 widget 配置后，这些值将按升序排序 （例如 "threshold.0.threshold":"5" → "threshold.0.threshold":"1"； "threshold.1.threshold":"1" → "threshold.1.threshold": "5"）。
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| Item | 1 | columns.0.item | 有效的 监控项 名称。 在 template dashboard 上配置 widget 时，应仅设置模板上配置的 监控项。 |
|
| Display | 0 | columns.0.display | 1 - (默认) 原样； 2 - 条形图； 3 - 指示器。 |
|
| Min | 1 | columns.0.min | 任意数值。 参数行为: - 如果 Display 设置为 "Bar" 或 "Indicators"，则支持 |
|
| Max | 1 | columns.0.max | 任意数值。 参数行为: - 如果 Display 设置为 "Bar" 或 "Indicators"，则支持 |
|
| Decimal places | 0 | columns.0.decimal_places | 可能的值范围为 0-10。 默认值: 2。 |
|
| Thresholds | ||||
| 颜色 | 1 | columnsthresholds.0.color.0 | 十六进制颜色代码（例如 FF0000）。默认值: ""（空）。 |
|
| 阈值 | 1 | columnsthresholds.0.threshold.0 | 任意 string 值。 | |
| Aggregation function | 0 | columns.0.aggregate_function | 0 - (默认) 未使用； 1 - 最小值； 2 - 最大值； 3 - 平均值； 4 - 计数； 5 - 总和； 6 - 第一个； 7 - 最后一个。 |
|
| Time period | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - 将 Time period selector 设置为数据源；ABCDE._timeperiod - 将 部件兼容性（其 reference 参数等于 ABCDE）设置为数据源。默认值: DASHBOARD._timeperiod或者，您可以仅在 From 和 To 参数中设置时间段。 参数行为: - 如果 Aggregation function 设置为 "min"、"max"、"avg"、"count"、"sum"、"first"、"last"，则支持 |
|
| From | 1 | columns.0.time_period.from | 以绝对时间（YYYY-MM-DD hh:mm:ss）或 relative 时间语法（now、now/d、now/w-1w 等）表示的有效时间 string。参数行为: - 如果 Time period 未设置且 Aggregation function 设置为 "min"、"max"、"avg"、"count"、"sum"、"first"、"last"，则支持 |
|
| To | 1 | columns.0.time_period.to | 以绝对时间（YYYY-MM-DD hh:mm:ss）或 relative 时间语法（now、now/d、now/w-1w 等）表示的有效时间 string。参数行为: - 如果 Time period 未设置且 Aggregation function 设置为 "min"、"max"、"avg"、"count"、"sum"、"first"、"last"，则支持 |
|
| History data | 0 | columns.0.history | 0 - (默认) 自动； 1 - 历史数据； 2 - 趋势数据。 |
|
| Reference | 1 | reference | 由 5 字符组成的任意 string 值（例如 ABCDE 或 JBPNL）。此值在 widget 所属的仪表板中必须唯一。参数行为: - 必填 |
|
文本
如果将 Data 设置为 "Text"，则支持以下参数。
| 参数 | 仪表板小部件字段 | 名称 | 值 |
|---|---|---|---|
| Text | 1 | columns.0.text | 任意 string 值，包括宏。 支持的宏：{主机.*}, {INVENTORY.*}。 参数行为: - 如果 Data 设置为 "Text"，则为必填 |
示例
以下示例仅用于描述仪表板中 Top 主机 小组件的仪表板 widget 字段 objects 的配置。 有关配置仪表板的更多信息，请参阅 dashboard.create。
配置 Top 主机 部件
配置一个Top 主机 widget，用于在主机组 "4"中按 CPU 使用率显示Top 主机。
此外，请配置以下自定义列："主机名"、"CPU 使用率 %"、"1m avg"、"5m avg"、"15m avg"、"进程"。
执行请求:
{
"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
}响应: