17 监控项值

说明

各个仪表盘组件字段对象中的这些参数和可用属性值允许在dashboard.create 和 dashboard.update 方法中配置监控项值组件。

在创建或更新仪表盘期间不会验证组件的 fields 属性。 这个方法允许用户修改内置组件和创建自定义组件，但也会导致存在错误创建或更新组件的风险。 为确保成功创建或更新监控项值组件，请参阅下表中概述的参数行为。

参数

监控项值组件支持以下参数：

参数类型参数名称参数值或参数说明
刷新频率0rf_rate0 - 不刷新；
10 - 10 秒；
30 - 30 秒；
60 - (默认) 1 分钟；
120 - 2 分钟；
600 - 10 分钟；
900 - 15 分钟。
监控项4itemid.0监控项 ID。

参数行为：
- 必需的 (如果未设置 监控项 (组件))。
监控项 (组件)1itemid._reference用于替代监控项 ID：
ABCDE._itemid - 将一个 标识符 参数为 ABCDE 的兼容性组件作为数据源。

参数行为：
- 必需的 (如果未设置 监控项)。
显示0show.01 - 说明；
2 - 值；
3 - 时间；
4 - 变动指标。

默认值： 1、2、3、4(全部启用)。

注意：如果需要配置多个值，则需要给每个值创建一个仪表盘组件字段对象，参数名称 statuses.0 中的数字按照顺序进行递增。
覆盖主机1override_hostid._referenceABCDE._hostid - 将一个 标识符 参数为 ABCDE 的兼容性组件作为数据源；
DASHBOARD._hostid - 将主机选择器作为数据源。

在仪表盘模板中定义组件时，此参数不可用。

高级配置

监控项值组件支持以下高级配置参数：

参数名称 阈值 (例如：thresholds.0.color)中的数字与提供的参数列表需要一致，且升序排序。例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。 如果传入的数字未按照升序排序，则 Zabbix 前端更新组件时会自动按照升序排序。 (例如："thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"； "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5")

参数类型参数名称参数值或参数说明
背景颜色1bg_color十六进制颜色代码(例如：FF0000)。

默认值：“” (空)。
阈值
颜色1thresholds.0.color十六进制颜色代码(例如：FF0000)。
阈值1thresholds.0.threshold任意字符串。
聚合函数0aggregate_function0 - (默认) 未使用；
1 - min；
2 - max；
3 - avg；
4 - count；
5 - sum；
6 - first；
7 - last。
时间期间1time_period._referenceDASHBOARD._timeperiod - 将时间期间选择器选择器作为数据源；
ABCDE._timeperiod - 将一个 标识符 参数为 ABCDE 的兼容性组件作为数据源。

默认值： DASHBOARD._timeperiod

另外，你也可以仅仅通过 From 和 To 参数指定时间周期。

参数行为：
- 支持 (如果 聚合函数 配置为 “min”、”max”、”avg”、”count”、”sum”、”first”、”last”)。
From1time_period.from绝对(YYYY-MM-DD hh:mm:ss)或相对(now、now/d、now/w-1w等)时间字符串。

参数行为：
- 支持 (如果未设置 时间期间 并且 聚合函数 设置为 “min”、”max”、”avg”、”count”、”sum”、”first”、”last”)。
To1time_period.to绝对(YYYY-MM-DD hh:mm:ss)或相对(now、now/d、now/w-1w等)时间字符串。

参数行为：
- 支持 (如果未设置 时间期间 并且 聚合函数 设置为 “min”、”max”、”avg”、”count”、”sum”、”first”、”last”)。
历史数据0history0 - (默认) 自动；
1 - 历史；
2 - 趋势。
说明

如果 显示 设置为 “说明”，则支持以下高级配置参数：

参数类型参数名称参数值或参数说明
说明1description任意字符串，包含宏变量
支持的宏变量如下：{HOST.}、{ITEM.}、{INVENTORY.*}、用户宏变量。

默认值： {ITEM.NAME}。
水平位置0desc_h_pos0 - 左侧；
1 - (默认) 居中；
2 - 右侧。

两个或多个元素(说明、值、时间)不能共享相同的 水平位置 和 垂直位置。
垂直位置0desc_v_pos0 - 顶部；
1 - 居中；
2 - (默认) 底部。

两个或多个元素(说明、值、时间)不能共享相同的 水平位置 和 垂直位置。
大小0desc_size可用值范围： 1-100。

默认值： 15。
粗体0desc_bold0 - (默认) 禁用；
1 - 启用。
颜色1desc_color十六进制颜色代码(例如：FF0000)。

默认值：“” (空)。
值

如果 显示 设置为 “值”，则支持以下高级配置参数：

参数类型参数名称参数值或参数说明
小数位数
小数位数0decimal_places可用值范围：1-10。

默认值：2。
大小0decimal_size可用值范围：1-100。

默认值：35。
位置
水平位置0value_h_pos0 - 左侧；
1 - (默认) 居中；
2 - 右侧。

两个或多个元素(说明, 值, 时间)不能共享相同的 水平位置 和 垂直位置。
垂直位置0value_v_pos0 - 顶部；
1 - (默认) 居中；
2 - 底部。

两个或多个元素(说明, 值, 时间)不能共享相同的 水平位置 和 垂直位置。
大小0value_size可用值范围：1-100。

默认值：45。
粗体0value_bold0 - 禁用；
1 - (默认) 启用。
颜色1value_color十六进制颜色代码(例如：FF0000)。

默认值：“” (空)。
单位
单位 (复选框)0units_show0 - 禁用；
1 - (默认) 启用。
单位 (值)1units任意字符串。
位置0units_pos0 - 值前；
1 - 值上；
2 - (默认) 值后；
3 - 值下。
大小0units_size可用值范围：1-100。

默认值：35。
粗体0units_bold0 - 禁用；
1 - (默认) 启用。
颜色1units_color十六进制颜色代码(例如：FF0000)。

默认值：“” (空)。
时间

如果 显示 设置为 “时间”，则支持以下高级配置参数：

参数类型参数名称参数值或参数说明
水平位置0time_h_pos0 - 左侧；
1 - (默认) 居中；
2 - 右侧。

两个或多个元素(说明, 值, 时间)不能共享相同的 水平位置 和 垂直位置。
垂直位置0time_v_pos0 - (默认) 顶部；
1 - 居中；
2 - 底部。

两个或多个元素(说明, 值, 时间)不能共享相同的 水平位置 和 垂直位置。
大小0time_size可用值范围：1-100。

默认值：15。
粗体0time_bold0 - (默认) 禁用；
1 - 启用。
颜色1time_color十六进制颜色代码(例如：FF0000)。

默认值：“” (空)。
变动指标

如果 显示 设置为 “变动指标”，则支持以下高级配置参数：

参数类型参数名称参数值或参数说明
变动指标 ↑ 颜色1up_color十六进制颜色代码(例如：FF0000)。

默认值：“” (空)。
变动指标 ↓ 颜色1down_color十六进制颜色代码(例如：FF0000)。

默认值：“” (空)。
变动指标 ↕ 颜色1updown_color十六进制颜色代码(例如：FF0000)。

默认值：“” (空)。

示例

以下示例仅用于介绍如何在仪表盘组件字段对象中配置 监控项值 组件。 更多信息，请参考 创建仪表盘。

配置一个监控项值 组件

配置一个监控项值组件，用于展示监控项 “42266” 的值(Zabbix agent 可用)。 此外，通过包含动态背景颜色在内的多个高级配置对组件进行视觉微调。 基于 Zabbix agent 可用性修改监控项值。

请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "dashboard.create",
  4.            "params": {
  5.                "name": "My dashboard",
  6.                "display_period": 30,
  7.                "auto_start": 1,
  8.                "pages": [
  9.                    {
  10.                        "widgets": [
  11.                            {
  12.                                "type": "item",
  13.                                "name": "Item value",
  14.                                "x": 0,
  15.                                "y": 0,
  16.                                "width": 12,
  17.                                "height": 3,
  18.                                "view_mode": 0,
  19.                                "fields": [
  20.                                    {
  21.                                        "type": 4,
  22.                                        "name": "itemid.0",
  23.                                        "value": 42266
  24.                                    },
  25.                                    {
  26.                                        "type": 0,
  27.                                        "name": "show.0",
  28.                                        "value": 1
  29.                                    },
  30.                                    {
  31.                                        "type": 0,
  32.                                        "name": "show.1",
  33.                                        "value": 2
  34.                                    },
  35.                                    {
  36.                                        "type": 0,
  37.                                        "name": "show.2",
  38.                                        "value": 3
  39.                                    },
  40.                                    {
  41.                                        "type": 1,
  42.                                        "name": "description",
  43.                                        "value": "Agent status"
  44.                                    },
  45.                                    {
  46.                                        "type": 0,
  47.                                        "name": "desc_h_pos",
  48.                                        "value": 0
  49.                                    },
  50.                                    {
  51.                                        "type": 0,
  52.                                        "name": "desc_v_pos",
  53.                                        "value": 0
  54.                                    },
  55.                                    {
  56.                                        "type": 0,
  57.                                        "name": "desc_bold",
  58.                                        "value": 1
  59.                                    },
  60.                                    {
  61.                                        "type": 1,
  62.                                        "name": "desc_color",
  63.                                        "value": "F06291"
  64.                                    },
  65.                                    {
  66.                                        "type": 0,
  67.                                        "name": "value_h_pos",
  68.                                        "value": 0
  69.                                    },
  70.                                    {
  71.                                        "type": 0,
  72.                                        "name": "value_size",
  73.                                        "value": 25
  74.                                    },
  75.                                    {
  76.                                        "type": 1,
  77.                                        "name": "value_color",
  78.                                        "value": "FFFF00"
  79.                                    },
  80.                                    {
  81.                                        "type": 0,
  82.                                        "name": "units_show",
  83.                                        "value": 0
  84.                                    },
  85.                                    {
  86.                                        "type": 0,
  87.                                        "name": "time_h_pos",
  88.                                        "value": 2
  89.                                    },
  90.                                    {
  91.                                        "type": 0,
  92.                                        "name": "time_v_pos",
  93.                                        "value": 2
  94.                                    },
  95.                                    {
  96.                                        "type": 0,
  97.                                        "name": "time_size",
  98.                                        "value": 10
  99.                                    },
  100.                                    {
  101.                                        "type": 0,
  102.                                        "name": "time_bold",
  103.                                        "value": 1
  104.                                    },
  105.                                    {
  106.                                        "type": 1,
  107.                                        "name": "time_color",
  108.                                        "value": "9FA8DA"
  109.                                    },
  110.                                    {
  111.                                        "type": 1,
  112.                                        "name": "thresholds.0.color",
  113.                                        "value": "E1E1E1"
  114.                                    },
  115.                                    {
  116.                                        "type": 1,
  117.                                        "name": "thresholds.0.threshold",
  118.                                        "value": "0"
  119.                                    },
  120.                                    {
  121.                                        "type": 1,
  122.                                        "name": "thresholds.1.color",
  123.                                        "value": "D1C4E9"
  124.                                    },
  125.                                    {
  126.                                        "type": 1,
  127.                                        "name": "thresholds.1.threshold",
  128.                                        "value": "1"
  129.                                    }
  130.                                ]
  131.                            }
  132.                        ]
  133.                    }
  134.                ],
  135.                "userGroups": [
  136.                    {
  137.                        "usrgrpid": 7,
  138.                        "permission": 2
  139.                    }
  140.                ],
  141.                "users": [
  142.                    {
  143.                        "userid": 1,
  144.                        "permission": 3
  145.                    }
  146.                ]
  147.            },
  148.            "id": 1
  149.        }

响应：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "dashboardids": [
  5.                    "3"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

参考