27 Top 主机

描述

这些参数及对应仪表板小组件字段objects的可选属性值 允许在dashboard.createdashboard.update方法中配置Top hosts小组件

小组件fields属性在仪表板创建或update过程中不会被验证 这使得用户可以修改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仪表板小部件字段object,为每个主机组在属性名称中使用递增数字.

如果在template dashboard上配置小部件,则不支持此参数.
主机 groups (Widget) 1 groupids._reference 替代Host group ID:
ABCDE._hostgroupids - 设置部件兼容性(其Reference参数设置为"ABCDE")作为主机组的数据源.

如果在template dashboard上配置小部件,则不支持此参数.
Hosts 3 hostids.0 Host ID.

注意: 要配置多个主机,请create仪表板小部件字段object,为每个主机在属性名称中使用递增数字. 对于多个主机,参数主机 groups必须完全不配置或至少配置一个包含所配置主机的主机组.

如果在template dashboard上配置小部件,则不支持此参数.
主机 (Widget/Dashboard) 1 hostids._reference 替代Host ID:
DASHBOARD.hostids - 设置覆盖主机作为主机的数据源;
ABCDE._hostids - 设置部件兼容性(其Reference参数设置为"ABCDE")作为主机的数据源.

如果在template dashboard上配置小部件,则不支持此参数.
Host tags
Evaluation type 0 evaltype 0 - (默认) And/Or;
2 - Or.

如果在template dashboard上配置小部件,则不支持此参数.
Tag name 1 tags.0.tag 任何string值.

注意: 属性名称中的数字引用标签评估列表中的标签顺序.

参数行为:
- 必需 如果配置主机 tags

如果在template dashboard上配置小部件,则不支持此参数.
Operator 0 tags.0.operator 0 - 包含;
1 - 等于;
2 - 不包含;
3 - 不等于;
4 - 存在;
5 - 不存在.

注意: 属性名称中的数字引用标签评估列表中的标签顺序.

参数行为:
- 必需 如果配置主机 tags

如果在template dashboard上配置小部件,则不支持此参数.
Tag value 1 tags.0.value 任何string值.

注意: 属性名称中的数字引用标签评估列表中的标签顺序.

参数行为:
- 必需 如果配置主机 tags

如果在template dashboard上配置小部件,则不支持此参数.
Show hosts in maintenance 0 maintenance 0 - (默认) 禁用;
1 - 启用.
Columns (see below)
Order by 0 column 从配置的列中获取的列数值.
Order 0 order 2 - (默认) Top N;
3 - Bottom N.
Host limit 0 show_lines 可能的值范围为1-1000.

默认: 10.

如果在template dashboard上配置小部件,则不支持此参数.

列具有通用参数和根据数据参数配置而定的附加参数。

所有与列相关的参数中,属性名称中的数字(例如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)。

参数行为:
- 必填
监控项值

如果数据设置为"监控项值",则支持以下参数。

Thresholds属性名称中的第一个数字(例如columnsthresholds.0.color.0)引用配置阈值的列, 而第二个数字引用按升序排序的阈值位置。 但是,如果以不同顺序配置阈值,在Zabbix前端更新小部件配置后,值将按升序排序 (例如"threshold.0.threshold":"5""threshold.0.threshold":"1""threshold.1.threshold":"1""threshold.1.threshold": "5")。

参数 仪表板小部件字段 名称
Item 1 columns.0.item 有效的监控项名称。

template dashboard上配置小部件时,只应设置模板上配置的监控项。
Display item value as 0 columns.0.display_value_as 0 - (默认) 数值;
1 - 文本;
2 - 二进制。
Display 0 columns.0.display 1 - (默认) 原样;
2 - 条形图;
3 - 指示器;
6 - 迷你图。

参数行为:
- 支持 如果显示监控项值设置为"数值"
Min 1 columns.0.min 任何数值。

参数行为:
- 支持 如果显示监控项值设置为"数值"且显示设置为"条形图"或"指示器"
Max 1 columns.0.max 任何数值。

参数行为:
- 支持 如果显示监控项值设置为"数值"且显示设置为"条形图"或"指示器"
Decimal places 0 columns.0.decimal_places 可能的值范围为0-10。

默认:2。

参数行为:
- 支持 如果显示监控项值设置为"数值"
Sparkline
宽度 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 - 将Time period selector设置为数据源;
ABCDE._timeperiod - 将部件兼容性(其reference参数等于ABCDE)设置为数据源。

默认:DASHBOARD._timeperiod

或者,您可以在参数中仅设置时间段。

参数行为:
- 支持 如果显示监控项值设置为"数值"且显示设置为"迷你图"
1 columns.0.sparkline.time_period.from 有效的string时间,使用绝对时间语法(YYYY-MM-DD hh:mm:ss)或relative时间语法(nownow/dnow/w-1w等)。

参数行为:
- 支持 如果显示监控项值设置为"数值"且显示设置为"迷你图"
1 columns.0.sparkline.time_period.to 有效的string时间,使用绝对时间语法(YYYY-MM-DD hh:mm:ss)或relative时间语法(nownow/dnow/w-1w等)。

参数行为:
- 支持 如果显示监控项值设置为"数值"且显示设置为"迷你图"
历史数据 0 columns.0.sparkline.history 0 - (默认) 自动;
1 - 历史;
2 - 趋势。

参数行为:
- 支持 如果显示监控项值设置为"数值"且显示设置为"迷你图"
Thresholds
颜色 1 columnsthresholds.0.color.0 十六进制颜色代码(例如FF0000)。

参数行为:
- 支持 如果显示监控项值设置为"数值"
阈值 1 columnsthresholds.0.threshold.0 任何string值。

参数行为:
- 支持 如果显示监控项值设置为"数值"
Highlights
颜色 1 columns.0.highlights.0.color 十六进制颜色代码(例如FF0000)。

参数行为:
- 支持 如果显示监控项值设置为"文本"
模式 1 columns.0.highlights.0.pattern 任何string值。

参数行为:
- 支持 如果显示监控项值设置为"文本"
Show thumbnail 0 columns.0.show_thumbnail 0 - (默认) 禁用;
1 - 启用。

参数行为:
- 支持 如果显示监控项值设置为"二进制"
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

或者,您可以在参数中仅设置时间段。

参数行为:
- 支持 如果聚合函数设置为"最小"、"最大"、"平均"、"计数"、"总和"、"第一个"、"最后一个"
1 columns.0.time_period.from 有效的string时间,使用绝对时间语法(YYYY-MM-DD hh:mm:ss)或relative时间语法(nownow/dnow/w-1w等)。

参数行为:
- 支持 如果时间段未设置且聚合函数设置为"最小"、"最大"、"平均"、"计数"、"总和"、"第一个"、"最后一个"
1 columns.0.time_period.to 有效的string时间,使用绝对时间语法(YYYY-MM-DD hh:mm:ss)或relative时间语法(nownow/dnow/w-1w等)。

参数行为:
- 支持 如果时间段未设置且聚合函数设置为"最小"、"最大"、"平均"、"计数"、"总和"、"第一个"、"最后一个"
History data 0 columns.0.history 0 - (默认) 自动;
1 - 历史;
2 - 趋势。

参数行为:
- 支持 如果显示监控项值设置为"数值"
Reference 1 reference 任何由5个字符组成的string值(例如ABCDEJBPNL)。此值在小部件所属的仪表板中必须唯一。

参数行为:
- 必需
文本

如果Data设置为"Text",则支持以下参数。

参数 仪表板小部件字段 名称
Text 1 columns.0.text 任何string值,包括宏。
支持的宏:{主机.*}、{INVENTORY.*}。

参数行为:
- 当Data设置为"Text"时必填

示例

以下示例仅描述Top 主机小部件的仪表板小部件字段objects的配置。 有关配置仪表板的更多信息,请参阅dashboard.create

配置 Top 主机 部件

配置一个显示Top 主机的Top 主机部件,按CPU使用率在主机组 "4"中展示。 此外,配置以下自定义列:"主机名"、"CPU使用率(%)"、"1分钟平均值"、"5分钟平均值"、"15分钟平均值"、"进程数"。

执行请求:

{
           "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
       }

响应:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "3"
               ]
           },
           "id": 1
       }

另请参阅