9 图形(经典)
描述
这些参数以及相应仪表板小部件字段对象的可选属性值,可用于在 dashboard.create 和 dashboard.update 方法中配置 Graph (classic) 小部件。
在创建或更新仪表板期间,不会对小部件 fields 属性进行验证。
这使用户能够修改内置小部件并创建自定义小部件,但同时也带来了错误创建或更新小部件的风险。
为确保成功创建或更新 Graph (classic) 小部件,请参阅下表中列出的参数行为。
参数
以下参数适用于 Graph (classic) 部件。
| 参数 | type | name | value | |
|---|---|---|---|---|
| 刷新间隔 | 0 | rf_rate | 0 - 不刷新; 10 - 10 秒; 30 - 30 秒; 60 - (默认) 1 分钟; 120 - 2 分钟; 600 - 10 分钟; 900 - 15 分钟。 |
|
| 来源 | 0 | source_type | 0 - (默认) 图形; 1 - 简单图形。 |
|
| 图形 | 6 | graphid.0 | Graph ID。 参数行为: - 如果 来源 设置为“图形”,则为必需 |
|
| 图形(部件) | 1 | graphid._reference | 用于代替 Graph ID:ABCDE._graphid - 将兼容部件(其 Reference 参数设置为 "ABCDE")设置为图形的数据源。参数行为: - 如果 来源 设置为“简单图形”且未设置 图形,则为必需 |
|
| 监控项 | 4 | itemid.0 | Item ID。 参数行为: - 如果 来源 设置为“简单图形”且未设置 监控项(部件),则为必需 |
|
| 监控项(部件) | 1 | itemid._reference | 用于代替 Item ID:ABCDE._itemid - 将兼容部件(其 Reference 参数设置为 "ABCDE")设置为监控项的数据源。参数行为: - 如果 来源 设置为“简单图形”且未设置 监控项,则为必需 |
|
| 时间段 | 1 | time_period._reference | DASHBOARD._timeperiod - 将仪表板时间段选择器设置为数据源;ABCDE._timeperiod - 将兼容部件(其 Reference 参数设置为 "ABCDE")设置为数据源。默认值: DASHBOARD._timeperiod或者,也可以仅在 From 和 To 参数中设置时间段。 |
|
| From | 1 | time_period.from | 绝对时间(YYYY-MM-DD hh:mm:ss)或相对时间语法(now、now/d、now/w-1w 等)的有效时间字符串。参数行为: - 在未设置 时间段 时支持 - 如果设置了 time_period.to,则为必需 |
|
| To | 1 | time_period.to | 绝对时间(YYYY-MM-DD hh:mm:ss)或相对时间语法(now、now/d、now/w-1w 等)的有效时间字符串。参数行为: - 在未设置 时间段 时支持 - 如果设置了 time_period.from,则为必需 |
|
| 显示图例 | 0 | show_legend | 0 - 禁用; 1 - (默认) 启用。 |
|
| 覆盖主机 | 1 | override_hostid._reference | ABCDE._hostid - 将兼容部件(其 Reference 参数设置为 "ABCDE")设置为主机的数据源;DASHBOARD._hostid - 将仪表板主机选择器设置为主机的数据源。如果在模板仪表板上配置该部件,则不支持此参数。 |
|
| Reference | 1 | reference | 由 5 个字符组成的任意字符串值(例如 ABCDE 或 JBPNL)。该值在部件所属的仪表板内必须唯一。参数行为: - 必需 |
|
示例
以下示例仅用于介绍如何在仪表盘组件字段对象中配置图表(经典)组件。 更多信息,请参考 创建仪表盘。
配置一个图表(经典)组件
配置一个图表(经典)组件,用于展示监控项 "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
}