模版仪表盘对象

以下对象与 templatedashboard API 直接相关。

模版仪表盘

模版仪表盘对象有下列属性。

属性 类型 描述
dashboardid ID 模版仪表板的ID。

属性行为:
- 只读
- 对于更新操作是必需
name string 模版仪表盘的名称。

属性行为:
- 对于创建操作是必需
templateid ID 仪表板所属模板的ID。

属性行为:
- 常量
- 对于创建操作是必需
display_period integer 默认页面显示时段 (单位是秒).

可能的值: 10, 30, 60, 120, 600, 1800, 3600.

默认: 30.
auto_start integer 自动开始幻灯片播放.

可能的值:
0 - 关闭自动开始幻灯片播放;
1 - (默认) 打开自动开始幻灯片播放。
uuid string 用于将导入的模板仪表板链接到已有仪表板的通用唯一标识符。如果未提供,将自动生成。

模版仪表盘页面

模板仪表盘页面对象具有以下属性。

属性 类型 描述
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 - 仪表;
graph - 图表(经典);
graphprototype - 图表原型;
honeycomb - 蜂窝图;
hostavail - 主机可用性;
hostnavigator - 主机导航器;
itemnavigator - 监控项导航器;
item - 监控项值;
map - 拓扑图;
navtree - 拓扑图导航树;
piechart - 饼图;
plaintext - 纯文本;
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 - 字符串;
4 - 监控项;
5 - 监控项原型;
6 - 图表;
7 - 图表原型;
8 - 拓扑图;
9 - 服务;
10 - 服务等级协议(SLA);
11 - 用户;
12 - 动作;
13 - 媒体类型。

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

可能的值:参见 仪表盘小部件字段。注意,当在模板仪表盘上配置小部件时,某些与主机相关的参数(例如,在问题小部件中的主机组排除主机组主机,在主机可用性小部件中的主机组等)不可用。这是因为模板仪表盘仅显示与模板链接的主机的数据。

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

可能的值:参见 仪表盘小部件字段。注意,当在模板仪表盘上配置小部件时,某些与主机相关的参数(例如,在问题小部件中的主机组排除主机组主机,在主机可用性小部件中的主机组等)不可用。这是因为模板仪表盘仅显示与模板链接的主机的数据。

属性行为:
- 必填