11 图表原型

说明

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

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

参数

图表原型组件支持以下参数:

参数 类型 参数名称 参数值或参数说明
刷新频率 0 rf_rate 0 - 不刷新;
10 - 10 秒;
30 - 30 秒;
60 - (默认) 1 分钟;
120 - 2 分钟;
600 - 10 分钟;
900 - 15 分钟。
来源 0 source_type 2 - (默认) 图表原型;
3 - 简单图表原型。
图表原型 7 graphid.0 图表原型 ID。

参数行为
- 必需的 (如果来源设置为"图表原型")。
监控项原型 5 itemid.0 监控项原型 ID。

参数行为
- 必需的 (如果来源设置为"简单图表原型")。
时间期间 1 time_period._reference DASHBOARD._timeperiod - 将时间期间选择器选择器作为数据源;
ABCDE._timeperiod - 将一个 标识符 参数为 ABCDE兼容性组件作为数据源。

默认值: DASHBOARD._timeperiod

另外,你也可以仅仅通过 FromTo 参数指定时间周期。
From 1 time_period.from 绝对(YYYY-MM-DD hh:mm:ss)或相对(nownow/dnow/w-1w等)时间字符串。

参数行为
- 支持 (如果未设置 时间期间)。
To 1 time_period.to 绝对(YYYY-MM-DD hh:mm:ss)或相对(nownow/dnow/w-1w等)时间字符串。

参数行为
- 支持 (如果未设置 时间期间)。
显示图例 0 show_legend 0 - 禁用;
1 - (默认) 启用。
覆盖主机 1 override_hostid._reference ABCDE._hostid - 将一个 标识符 参数为 ABCDE兼容性组件作为数据源;
DASHBOARD._hostid - 将主机选择器作为数据源。

仪表盘模板中定义组件时,此参数不可用。
0 columns 可用值范围:1-24。

默认值:2。
0 rows 可用值范围:1-16。

默认值:1。
标识符 1 reference 任意 5 个英文字符组成的字符串(例如:ABCDEJBPNL)。在这个组件所属的仪表盘中,这个值必须是唯一的。

参数行为
- 必需的

示例

以下示例仅用于介绍如何在仪表盘组件字段对象中配置 图表原型组件。 更多信息,请参考 创建仪表盘

配置一个图表原型组件

配置一个图表原型组件,用于展示由低级别自动发现的监控项目原型 (ID: "42316") 创建的图表,同时设置布局为 3 个图表(即 3 列,1行)。

请求:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "graphprototype",
                               "name": "Graph prototype",
                               "x": 0,
                               "y": 0,
                               "width": 48,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 0,
                                       "name": "source_type",
                                       "value": 3
                                   },
                                   {
                                       "type": 5,
                                       "name": "itemid.0",
                                       "value": 42316
                                   },
                                   {
                                       "type": 0,
                                       "name": "columns",
                                       "value": 3
                                   },
                                   {
                                       "type": 1,
                                       "name": "reference",
                                       "value": "OPQWX"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

响应:

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

参考