9 图形(经典)

描述

这些参数及对应仪表板小组件字段objects的可选属性值,允许通过dashboard.createdashboard.update方法配置Graph (classic)小组件。

小组件fields的属性在仪表板创建或update过程中不会进行验证。 这使得用户可以修改built-in widgets和createcustom widgets,但也存在错误创建或更新小组件的风险。 为确保成功创建或update经典图形小组件,请参考下文表格中列出的参数行为规范。

参数

以下参数支持图表(经典)小部件。

参数 仪表板小部件字段 名称
Refresh interval 0 rf_rate 0 - 不刷新;
10 - 10秒;
30 - 30秒;
60 - (默认) 1分钟;
120 - 2分钟;
600 - 10分钟;
900 - 15分钟.
Source 0 source_type 0 - (默认) 图表;
1 - 简单图表.
Graph 6 graphid.0 Graph ID.

参数行为:
- 必填数据源设置为"图表"时
图表(小部件) 1 graphid._reference 替代Graph ID:
ABCDE._graphid - 设置部件兼容性(其引用参数设为"ABCDE")作为图表数据源.

参数行为:
- 必填数据源设为"简单图表"且未设置图表
Item 4 itemid.0 Item ID.

参数行为:
- 必填数据源设为"简单图表"且未设置监控项(小部件)
监控项(小部件) 1 itemid._reference 替代Item ID:
ABCDE._itemid - 设置部件兼容性(其引用参数设为"ABCDE")作为监控项数据源.

参数行为:
- 必填数据源设为"简单图表"且未设置监控项
Time period 1 time_period._reference DASHBOARD._timeperiod - 设置Time period selector为数据源;
ABCDE._timeperiod - 设置部件兼容性(其引用参数设为"ABCDE")为数据源.

默认: DASHBOARD._timeperiod

也可仅在起始时间结束时间参数中设置时间段.
起始时间 1 time_period.from 有效时间string,使用绝对时间格式(YYYY-MM-DD hh:mm:ss)或relative时间语法(now, now/d, now/w-1w等).

参数行为:
- 支持 当未设置时间段
结束时间 1 time_period.to 有效时间string,使用绝对时间格式(YYYY-MM-DD hh:mm:ss)或relative时间语法(now, now/d, now/w-1w等).

参数行为:
- 支持 当未设置时间段
Show legend 0 show_legend 0 - 禁用;
1 - (默认) 启用.
Override host 1 override_hostid._reference ABCDE._hostid - 设置部件兼容性(其引用参数设为"ABCDE")作为主机数据源;
DASHBOARD._hostid - 设置仪表板覆盖主机作为主机数据源.

template dashboard上配置小部件时不支持此参数.
Reference 1 reference 任意5字符string值(如ABCDEJBPNL). 该值在所属仪表板中必须唯一.

参数行为:
- 必填

示例

以下示例仅描述图表(经典)小工具的仪表板小工具字段objects的配置。 有关配置仪表板的更多信息,请参阅dashboard.create

配置 Graph (classic) 部件

配置一个Graph (classic)小部件,用于显示监控项 "42269"的简单图形。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "graph",
                               "name": "Graph (classic)",
                               "x": 0,
                               "y": 0,
                               "width": 36,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 0,
                                       "name": "source_type",
                                       "value": 1
                                   },
                                   {
                                       "type": 4,
                                       "name": "itemid.0",
                                       "value": 42269
                                   },
                                   {
                                       "type": 1,
                                       "name": "reference",
                                       "value": "RSTUV"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

响应:

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

另请参阅