9 图形(经典)

描述

这些参数以及相应仪表板小部件字段对象的可选属性值,可用于在 dashboard.createdashboard.update 方法中配置 Graph (classic) 小部件。

在创建或更新仪表板期间,不会对小部件 fields 属性进行验证。 这使用户能够修改内置小部件并创建自定义小部件,但同时也带来了错误创建或更新小部件的风险。 为确保成功创建或更新 Graph (classic) 小部件,请参阅下表中列出的参数行为。

参数

以下参数适用于 Graph (classic) 小组件。

Parameter type name value
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。

参数行为
- 如果 Source 设置为 "Graph",则为 必填
Graph (Widget) 1 graphid._reference 代替 Graph ID:
ABCDE._graphid - 将一个 兼容小组件(其 Reference 参数设置为 "ABCDE")设为图形的数据源。

参数行为
- 如果 Source 设置为 "Simple graph" 且未设置 Graph,则为 必填
Item 4 itemid.0 Item ID。

参数行为
- 如果 Source 设置为 "Simple graph" 且未设置 Item (Widget),则为 必填
Item (Widget) 1 itemid._reference 代替 Item ID:
ABCDE._itemid - 将一个 兼容小组件(其 Reference 参数设置为 "ABCDE")设为监控项的数据源。

参数行为
- 如果 Source 设置为 "Simple graph" 且未设置 Item,则为 必填
Time period 1 time_period._reference DASHBOARD._timeperiod - 将 Time period 选择器设为数据源;
ABCDE._timeperiod - 将一个 兼容小组件(其 Reference 参数设置为 "ABCDE")设为数据源。

默认值:DASHBOARD._timeperiod

或者,你也可以仅在 FromTo 参数中设置时间段。
From 1 time_period.from 有效的时间字符串,支持绝对时间语法(YYYY-MM-DD hh:mm:ss)或 相对时间语法(nownow/dnow/w-1w 等)。

参数行为
- 如果未设置 Time period,则为 支持
- 如果设置了 time_period.to,则为 必填
To 1 time_period.to 有效的时间字符串,支持绝对时间语法(YYYY-MM-DD hh:mm:ss)或 相对时间语法(nownow/dnow/w-1w 等)。

参数行为
- 如果未设置 Time period,则为 支持
- 如果设置了 time_period.from,则为 必填
Show legend 0 show_legend 0 - 禁用;
1 - (默认) 启用。
Override host 1 override_hostid._reference ABCDE._hostid - 将一个 兼容小组件(其 Reference 参数设置为 "ABCDE")设为主机的数据源;
DASHBOARD._hostid - 将仪表板的 Host 选择器设为主机的数据源。

如果在 模板仪表板上配置该小组件,则不支持此参数。
Reference 1 reference 任意由 5 个字符组成的字符串值(例如 ABCDEJBPNL)。此值在该小组件所属的仪表板内必须唯一。

参数行为
- 必填

示例

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

配置一个图表(经典)组件

配置一个图表(经典)组件,用于展示监控项 "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
}

参考