Table of Contents
> 仪表盘 object
以下objects与dashboard API直接相关.
仪表板
仪表板 object 具有以下属性.
| 属性 | 数据类型 | 描述 |
|---|---|---|
| dashboardid | string | (只读) 仪表板的ID. |
| name (required) |
string | 仪表板的名称. |
| userid | string | 仪表板所有者的用户ID. |
| private | integer | 仪表板共享类型. 可能的值: 0 - 公共仪表板; 1 - (默认) 私有仪表板. |
| display_period | integer | 默认页面显示周期(以秒为单位). 可能的值: 10, 30, 60, 120, 600, 1800, 3600. 默认值: 30. |
| auto_start | integer | 自动启动幻灯片播放. 可能的值: 0 - 不自动启动幻灯片播放; 1 - (默认) 自动启动幻灯片播放. |
请注意，对于某些方法 (update, delete) 所需/可选参数的组合是不同的.
仪表板页面
仪表板页面object具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| dashboard_pageid | string | (只读) 仪表板页面的ID。 |
| name | string | 仪表板页面名称。 默认值：空string。 |
| display_period | integer | 仪表板页面显示周期（以秒为单位）。 可能的值：0, 10, 30, 60, 120, 600, 1800, 3600。 默认值：0（将使用默认页面显示周期）。 |
| widgets | array | array的仪表板小部件objects。 |
仪表板小部件
仪表板小部件object具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| widgetid | string | (只读) 仪表板小部件的ID。 |
| type (required) |
string | 仪表板小部件的类型。 可能的值： actionlog - 操作日志； clock - 时钟； (已弃用) dataover - 数据概览； discovery - 发现状态； favgraphs - 收藏图表； favmaps - 收藏地图； geomap - 地理地图； graph - 图表（经典）； graphprototype - 图表原型； hostavail - 主机可用性； 监控项 - 监控项值； map - 地图； navtree - 地图导航树； plaintext - 纯文本； problemhosts - 问题主机； problems - 问题； problemsbysv - 按严重程度分类的问题； slareport - SLA报告； svggraph - 图表； systeminfo - 系统信息； tophosts - Top 主机； trigover - 触发器概览； url - URL； web - 网页监控。 |
| name | string | 自定义小部件名称。 |
| x | integer | 距离仪表板左侧的水平位置。 有效值范围为0到23。 |
| y | integer | 距离仪表板Top的垂直位置。 有效值范围为0到62。 |
| width | integer | 小部件宽度。 有效值范围为1到24。 |
| height | integer | 小部件高度。 有效值范围为2到32。 |
| view_mode | integer | 小部件视图模式。 可能的值： 0 - (默认) 默认小部件视图； 1 - 隐藏标题； |
| fields | array | 仪表板小部件字段objects的array。 特定小部件需要；参见Dashboard widget fields中的各个小部件。 |
仪表板小部件字段
仪表板小部件字段object具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| type (required) |
integer | 小部件字段类型。 可能的值： 0 - integer; 1 - string; 2 - 主机组; 3 - 主机; 4 - 监控项; 5 - 监控项原型; 6 - 图形; 7 - 图形原型; 8 - 地图; 9 - 服务; 10 - SLA。 |
| name (required) |
string | 小部件字段名称。 可能的值：参见Dashboard widget fields。 |
| value (required) |
mixed | 根据类型确定的小部件字段值。 可能的值：参见Dashboard widget fields。 |
Dashboard 用户组
基于用户组的仪表板权限列表. 具有以下属性.
| 属性 | 数据类型 | 描述 |
|---|---|---|
| usrgrpid (required) |
string | 用户组ID. |
| permission (required) |
integer | 权限级别类型. 可能的值: 2 - 只读; 3 - 读写. |
仪表盘用户
基于用户的仪表板权限列表。包含以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| userid (required) |
string | 用户ID。 |
| permission (required) |
integer | 权限级别类型。 可选值： 2 - 只读； 3 - 读写。 |