这是原厂英文文档的翻译页面. 欢迎帮助我们 完善文档.
2022 Zabbix中国峰会
2022 Zabbix中国峰会

> 仪表盘对象

下列对象与dashboard(仪表盘) API 直接相关。

仪表盘

仪表盘对象具有以下属性:

属性 类型 说明
dashboardid 字符 (只读) 仪表盘ID。
name
(必需)
字符 仪表盘名称。
userid 字符 仪表盘所属用户的用户ID。
private 整数 仪表盘的共享类型。

可用值:
0 - 公共仪表盘;
1 - (默认) 私有仪表盘。
display_period 整数 默认页面显示周期(秒)。

可用值:10,30,60,120,600,1800,3600。

默认:30。
auto_start 整数 自动幻灯片放映。

可用值:
0 - 不自动开始幻灯片放映;
1 - (默认) 自动开始幻灯片放映。

注意,对于某些方法(更新、删除),必需/可选参数组合是不同的。

仪表盘页面

仪表盘页面对象具有如下属性:

属性 类型 说明
dashboard_pageid string (只读) 仪表盘页面ID。
name string 仪表盘页面名称。

默认:空字符串。
display_period integer 仪表盘页面显示周期(秒)。

可用值:0,10,30,60,120,600,1800,3600。

默认:0(使用默认页显示周期)。
widgets array 仪表盘部件对象数组。

仪表盘部件

仪表盘部件对象具有如下属性:

属性 类型 说明
widgetid string (只读) 仪表盘部件ID。
type
(必需)
string 仪表盘部件类型。

可用值:
actionlog - 动作日志;
clock - 时钟;
dataover - 数据预览;
discovery - 发现状态;
favgraphs - 常用的图形;
favmaps - 常用的拓扑图;
graph - 图形 (经典);
graphprototype - 图原型;
hostavail - 主机可用性;
item - 监控项值;
map - 拓扑图;
navtree - 拓扑图导航树;
plaintext - 纯文本;
problemhosts - 有问题的主机;
problems - 问题;
problemsbysv - 问题的严重性;
svggraph - svg图形;
systeminfo - 系统信息;
tophosts - Top主机;
trigover - 触发器概览;
url - URL;
web - 网站监控。
name string 自定义组件名称。
x integer 从仪表盘左侧开始的的水平位置(x轴)。

有效值范围从 0 到 23。
y integer 从仪表盘顶部开始的垂直位置(y轴)。

有效值范围从 0 到 62。
width integer 部件的宽度。

有效值范围从 1 到 24。
height integer 部件的高度。

有效值范围从 2 到 32。
view_mode integer 部件的查看模式。

可用值:
0 - (默认) 默认的部件模式;
1 - 带隐藏标题模式。
fields array 仪表板部件字段数组对象。

仪表板小部件字段

仪表板小部件字段对象具有以下属性。

属性 类型 描述
type
(必填)
整数 小部件字段的类型。

可能的值:
0 - 整数;
1 - 字符串;
2 - 主机组;
3 - 主机;
4 - 监控项;
5 - 监控项原型;
6 - 图形;
7 - 图形原型;
8 - 映射;
9 - 服务;
10 - SLA。
name
(必填)
string 小部件字段名称。

可能的值:参见 仪表板小部件字段
value
(必填)
mixed 小部件字段值取决于类型。

可能的值:请参阅仪表板小部件字段 .

仪表盘用户组

基于用户组的仪表盘权限列表。具有以下属性:

属性 类型 说明
usrgrpid
(必需)
string 用户组ID。
permission
(必需)
integer 权限级别类型。

可用值:
2 - 只读;
3 - 读写。

仪表盘用户

基于用户的仪表盘权限列表。其具有以下属性:

属性 类型 说明
userid
(必需)
string 用户ID。
permission
(必需)
integer 权限级别类型。

可用值:
2 - 只读;
3 - 读写。