10 图形原型

描述

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

小组件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 2 - (默认) 图形原型;
3 - 简单图形原型.
Graph prototype 7 graphid.0 Graph prototype ID.

参数行为:
- 必填 如果数据源设置为"图形原型"
Item prototype 5 itemid.0 Item prototype ID.

参数行为:
- 必填 如果数据源设置为"简单图形原型"
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上配置部件,则不支持此参数.
Columns 0 columns 可能的值范围为1-24.

默认: 2.
Rows 0 rows 可能的值范围为1-16.

默认: 1.
Reference 1 reference 任何由5个字符组成的string值(例如ABCDEJBPNL). 此值在部件所属的仪表板中必须唯一.

参数行为:
- 必填

示例

以下示例仅描述图形原型小部件的仪表板小部件字段objects的配置。 有关配置仪表板的更多信息,请参阅dashboard.create

配置 图形原型 部件

配置一个图形原型小部件,显示由低级发现创建的监控项原型(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
}

另请参阅