2022 Zabbix中国峰会
2022 Zabbix中国峰会

2 时钟

说明

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

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

参数

时钟组件支持以下参数:

参数 类型 参数名称 参数值或参数说明
刷新频率 0 rf_rate 0 - 不刷新;
10 - 10 秒;
30 - 30 秒;
60 - 1 分钟;
120 - 2 分钟;
600 - 10 分钟;
900 - (默认) 15 分钟.
时间类型 0 time_type 0 - (默认) 本地时间;
1 - 服务器时间;
2 - 主机时间.
时钟类型 0 clock_type 0 - (默认) 模拟时钟;
1 - 数字时钟.

时间类型 设置为 "主机时间" 时,以下参数可用

参数 类型 参数名称 参数值或参数说明
监控项 4 itemid.0 监控项 ID.

参数行为:
- 必需的

时钟类型 设置为 "数字时钟" 时,以下参数可用

参数 类型 参数名称 参数值或参数说明
显示 0 show.0 1 - 日期;
2 - (默认) 时间;
3 - 时区.

注意:如果需要配置多个值,则需要给每个值创建一个仪表盘组件字段对象,参数名称 show.0 中的数字按照顺序进行递增。

高级配置

时钟类型 设置为 "数字时钟" 时,以下参数可用

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

默认值: "" (空).
日期

时钟类型 设置为 "数字时钟",显示 设置为 "日期" 时,以下参数可用

参数 类型 参数名称 参数值或参数说明
大小 0 date_size 可用值范围: 1-100.

默认值: 20.
粗体 0 date_bold 0 - (默认) 禁用;
1 - 启用.
颜色 1 date_color 十六进制颜色代码(例如:FF0000)。

默认值: "" (空).
时间

时钟类型 设置为 "数字时钟",显示 设置为 "时间" 时,以下参数可用

参数 类型 参数名称 参数值或参数说明
大小 0 time_size 可用值范围: 1-100.

默认值: 30.
粗体 0 time_bold 0 - (默认) 禁用;
1 - 启用.
颜色 1 time_color 十六进制颜色代码(例如:FF0000)。

默认值: "" (空).
0 time_sec 0 - 禁用;
1 - (默认) 启用.
格式 0 time_format 0 - (默认) 24小时制;
1 - 12小时制.
时区

时钟类型 设置为 "数字时钟",显示 设置为 "时区" 时,以下参数可用

参数 类型 参数名称 参数值或参数说明
大小 0 tzone_size 可用值范围: 1-100.

默认值: 20.
粗体 0 tzone_bold 0 - (默认) 禁用;
1 - 启用.
颜色 1 tzone_color 十六进制颜色代码(例如:FF0000)。

默认值: "" (空).
时区 1 tzone_timezone 校验时区字符串(例如:Europe/Riga, system, UTC, 等)。所有支持的时区请查看PHP文档.

默认值: local.

参数行为:
- 支持 (如果时间类型设置为"本地时间" 或 "服务器时间")
格式 0 tzone_format 0 - (默认) Short;
1 - Full.

参数行为:
- 支持 (如果时间类型设置为"本地时间" 或 "服务器时间")

示例

以下示例仅用于介绍如何在仪表盘组件字段对象中配置时钟组件 更多信息,请参考 dashboard.create

配置一个时钟组件

配置一个时钟组件,用于展示一个显示当前日期、时间和时区的数字时钟

请求:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "clock",
                               "name": "Clock",
                               "x": 0,
                               "y": 0,
                               "width": 12,
                               "height": 3,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 0,
                                       "name": "clock_type",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.0",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.1",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.2",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "date_size",
                                       "value": 20
                                   },
                                   {
                                       "type": 1,
                                       "name": "date_color",
                                       "value": "E1E1E1"
                                   },
                                   {
                                       "type": 0,
                                       "name": "time_bold",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "tzone_size",
                                       "value": 10
                                   },
                                   {
                                       "type": 1,
                                       "name": "tzone_color",
                                       "value": "E1E1E1"
                                   },
                                   {
                                       "type": 1,
                                       "name": "tzone_timezone",
                                       "value": "Europe/Riga"
                                   },
                                   {
                                       "type": 0,
                                       "name": "tzone_format",
                                       "value": 1
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

响应:

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

参考