仪表盘对象

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

仪表盘

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

参数 类型 说明
dashboardid ID 仪表盘 ID。

属性行为:
- 只读
- 必需的 (更新操作)。
name string 仪表盘名称。

属性行为:
- 必需的 (创建操作)。
userid ID 仪表盘所属用户的ID。
private integer 仪表盘共享类型。

可用值:
0 - 公共仪表盘;
1 - (默认) 私有仪表盘。
display_period integer 默认展示仪表展示周期(秒)。

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

默认值: 30。
auto_start integer 是否自动进行幻灯片放映。

可用值:
0 -不进行自动放映;
1 - (默认) 自动进行放映。

仪表盘页面

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

参数 类型 说明
dashboard_pageid ID 仪表盘页面 ID。

属性行为:
- 只读
name string 仪表盘页面名称。

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

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

默认值: 0 (将会使用页面默认展示周期)。
widgets array 仪表盘组件 对象数组。

仪表盘小部件

仪表盘小部件对象具有以下属性。

属性 类型 描述
widgetid ID 仪表盘小部件的ID。

属性行为:
- 只读
type 字符串 仪表盘小部件的类型。

可能的值:
actionlog - 动作日志;
clock - 时钟;
(已废弃) dataover - 数据概览;
discovery - 发现状态;
favgraphs - 常用图表;
favmaps - 常用地图;
gauge - 仪表;
geomap - 地理图;
graph - 图表(经典);
graphprototype - 图表原型;
honeycomb - 蜂窝图;
hostavail - 主机可用性;
hostnavigator - 主机导航器;
itemhistory - 监控项历史;
itemnavigator - 监控项导航器;
item - 监控项值;
map - 拓扑图;
navtree - 拓扑图导航树;
piechart - 饼图;
problemhosts - 问题主机;
problems - 问题;
problemsbysv - 按严重性分类的问题;
slareport - 服务级别协议报告;
svggraph - 图表;
systeminfo - 系统信息;
tophosts - Top 主机;
toptriggers - Top 触发器;
trigover - 触发器概览;
url - URL;
web - Web 监控。

属性行为:
- 必需
name 字符串 自定义小部件名称。
x 整数 从仪表盘左侧开始的水平位置。

可能的值范围从 0 到 71。
y 整数 从仪表盘顶部开始的垂直位置。

可能的值范围从 0 到 63。
width 整数 小部件的宽度。

可能的值范围从 1 到 72。
height 整数 小部件的高度。

可能的值范围从 1 到 64。
view_mode 整数 小部件的视图模式。

可能的值:
0 - (默认) 默认小部件视图;
1 - 隐藏标题;
fields 数组 仪表盘小部件字段对象的数组。

属性行为:
- 参见 仪表盘小部件字段 中的各个小部件

仪表盘小部件字段

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

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

可能的值:
0 - 整数;
1 - 字符串;
2 - 主机组;
3 - 主机;
4 - 监控项;
5 - 监控项原型;
6 - 图表;
7 - 图表原型;
8 - 拓扑图;
9 - 服务;
10 - SLA;
11 - 用户;
12 - 动作;
13 - 媒体类型。

属性行为
- 必需
name 字符串 小部件字段名称。

可能的值:参见 仪表盘小部件字段

属性行为
- 必需
value 混合 根据类型的小部件字段值。

可能的值:参见 仪表盘小部件字段

属性行为
- 必需

仪表盘用户组

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

参数 类型 说明
usrgrpid ID 用户组 ID。

属性行为:
- 必需的
permission integer 权限级别类型。

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

属性行为:
- 必需的

仪表盘用户

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

属性 类型 说明
userid ID 用户 ID。

属性行为:
- 必需的
permission integer 权限级别类型。

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

属性行为:
- 必需的