Documentation
仪表盘对象
下列对象与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 | string | 仪表盘组件类型。 可用值: actionlog - 动作日志； clock - 时钟； (弃用的) dataover - 数据概览； discovery - 发现状态； favgraphs - 常用图表； favmaps - 常用拓扑图； gauge - 仪表盘(Gauge)； geomap - 地理地图(Geomap)； graph - 图表(经典)； graphprototype - 图表原型； honeycomb - 蜂窝图； hostavail - 主机可用性； hostnavigator - 主机导航器； itemhistory - 监控项历史； itemnavigator - 监控项导航器； item - 监控项值； map - 拓扑图； navtree - 拓扑图导航树； piechart - 饼图； problemhosts - 问题主机； problems - 问题； problemsbysv - 问题严重性； slareport - SLA报表； svggraph - SVG图表； systeminfo - 系统信息； tophosts - Top主机； toptriggers - Top触发器； trigover - 触发器概览； url - URL； web - Web监测。 属性行为: - 必需的。 |
| name | string | 自定义的组件名称。 |
| x | integer | 从仪表盘左侧开始的的水平位置(x轴)。 可用值范围: 0-71。 |
| y | integer | 从仪表盘顶部开始的垂直位置(y轴)。 可用值范围: 0-63。 |
| width | integer | 组件宽度。 可用值范围: 1-72。 |
| height | integer | 组件高度。 可用值范围: 1-64。 |
| view_mode | integer | 组件展示模式。 可用值: 0 - (默认) 默认组件展示模式； 1 - 带隐藏标题展示模式。 |
| fields | array | 仪表盘组件字段对象数组。 属性行为: - 请参阅: 仪表盘组件字段对象。 |
仪表盘组件字段
仪表盘组件字段对象具有以下属性：
| 参数 | 类型 | 说明 |
|---|---|---|
| type | integer | 仪表盘组件字段对象类型。 可用值: 0 - 整型数字； 1 - 字符串； 2 - 主机组； 3 - 主机； 4 - 监控项； 5 - 监控项原型； 6 - 图表； 7 - 图表原型； 8 - 拓扑图； 9 - 服务； 10 - SLA； 11 - 用户； 12 - 动作； 13 - 媒介类型。 属性行为: - 必需的。 |
| name | string | 组件字段名称。 可用值: 参考仪表盘组件字段。 属性行为: - 必需的。 |
| value | mixed | 组件字段值，不同的组件类型返回不同类型的值。 可用值: 参考仪表盘组件字段。 属性行为: - 必需的。 |
仪表盘用户组
基于用户组的仪表盘权限列表。具有以下属性：
仪表盘用户
基于用户的仪表盘权限列表。具有以下属性：