[comment]: # translation:outdated
[comment]: # aside: 1
[comment]: # ({057bb0ae-a79e0e24})
# 仪表板 object
以下objects与`dashboard`API直接相关。
[comment]: # ({/057bb0ae-a79e0e24})
[comment]: # ({d0b4c961-63e4049e})
### 仪表板
仪表板 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| dashboardid | ID | 仪表板的 ID。
[属性行为](/manual/api/reference_commentary#属性行为):
- *只读*
- update 操作的*必填项* |
| name | string | 仪表板的名称。
[属性行为](/manual/api/reference_commentary#属性行为):
- create 操作的*必填项* |
| userid | ID | 仪表板所有者的用户 ID。 |
| private | integer | 仪表板共享类型。
可能的值：
0 - 公共仪表板；
1 - *(默认)* 私有仪表板。 |
| display\_period | integer | 默认页面显示时长（以秒为单位）。
可能的值：10、30、60、120、600、1800、3600。
默认值：30。 |
| auto\_start | integer | 自动开始幻灯片播放。
可能的值：
0 - 不自动开始幻灯片播放；
1 - *(默认)* 自动开始幻灯片播放。 |
[comment]: # ({/d0b4c961-63e4049e})
[comment]: # ({c2c47ca3-b88f0a6a})
### 仪表板页面
仪表板页面 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| dashboard\_pageid | ID | 仪表板页面的ID。
[属性行为](/manual/api/reference_commentary#属性行为):
- *只读* |
| name | string | 仪表板页面名称。
默认值：空 string。 |
| display\_period | integer | 仪表板页面显示周期（以秒为单位）。
可能的取值：0, 10, 30, 60, 120, 600, 1800, 3600。
默认值：0（将使用默认页面显示周期）。 |
| widgets | array | array 的 [仪表板小部件](object#仪表板小部件) objects。 |
[comment]: # ({/c2c47ca3-b88f0a6a})
[comment]: # ({763f1d85-2938b685})
#### 仪表盘部件
仪表板小get object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| widgetid | ID | 仪表板小部件的ID。
[属性行为](/manual/api/reference_commentary#属性行为):
- *只读* |
| type | string | 仪表板小部件的类型。
可能的值：
actionlog - 操作日志；
clock - 时钟；
*(已弃用)* dataover - 数据概览；
discovery - 发现状态；
favgraphs - 喜欢的图表；
favmaps - 喜欢的地图；
gauge - 仪表；
geomap - 地图；
graph - 图表（经典）；
graphprototype - 图表原型；
honeycomb - 蜂窝；
hostavail - 主机 可用性；
hostnavigator - 主机 导航器；
itemhistory - 监控项 历史；
itemnavigator - 监控项 导航器；
监控项 - 监控项 值；
map - 地图；
navtree - 地图导航树；
piechart - 饼图；
problemhosts - 问题主机；
problems - 问题；
problemsbysv - 按严重性划分的问题；
slareport - SLA报告；
svggraph - 图表；
systeminfo - 系统信息；
tophosts - Top 主机；
toptriggers - Top 触发器；
trigover - 触发器概览；
url - URL；
web - 网络监控。
[属性行为](/manual/api/reference_commentary#属性行为):
- *必填* |
| name | string | 自定义小get 名称。 |
| x | integer | 从仪表板左侧开始的水平位置。
可能的值范围为 0 到 71。 |
| y | integer | 从仪表板的Top开始的垂直位置。
可能的值范围为 0 到 63。 |
| width | integer | 小get 的宽度。
可能的值范围为 1 到 72。 |
| height | integer | 小get 的高度。
可能的值范围为 1 到 64。 |
| view\_mode | integer | 小get 的视图模式。
可能的值：
0 - *(默认)* 默认小get 视图；
1 - 隐藏标题； |
| fields | array | [dashboard widget field](object#dashboard-widget-field) objects 的array。
[属性行为](/manual/api/reference_commentary#属性行为):
- 在[Dashboard widget fields](/manual/api/reference/dashboard/widget_fields)中查看各个小部件 |
[comment]: # ({/763f1d85-2938b685})
[comment]: # ({a250f0b3-5b20bc04})
##### 仪表盘部件字段
仪表板 widget 字段 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| type | integer | widget 字段的类型。
可能的值：
0 - integer；
1 - string；
2 - 主机组；
3 - 主机；
4 - 监控项；
5 - 监控项 原型；
6 - 图形；
7 - 图形原型；
8 - 地图；
9 - 服务；
10 - SLA；
11 - 用户；
12 - 动作；
13 - 媒介类型。
[属性行为](/manual/api/reference_commentary#属性行为)：
- *必填* |
| name | string | widget 字段名称。
可能的值：参见 [Dashboard widget fields](/manual/api/reference/dashboard/widget_fields)。
[属性行为](/manual/api/reference_commentary#属性行为)：
- *必填* |
| value | mixed | 根据类型决定的 widget 字段值。
可能的值：参见 [Dashboard widget fields](/manual/api/reference/dashboard/widget_fields)。
[属性行为](/manual/api/reference_commentary#属性行为)：
- *必填* |
[comment]: # ({/a250f0b3-5b20bc04})
[comment]: # ({8b2512d6-5c8b3411})
### Dashboard 用户组
基于用户组的仪表板权限列表。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| usrgrpid | ID | 用户组的ID。
[属性行为](/manual/api/reference_commentary#属性行为):
- *必填* |
| permission | integer | 权限级别类型。
可能的值：
2 - 只读；
3 - 读写。
[属性行为](/manual/api/reference_commentary#属性行为):
- *必填* |
[comment]: # ({/8b2512d6-5c8b3411})
[comment]: # ({cc6bb7e5-d34afa0c})
### 仪表盘用户
基于用户的仪表板权限列表。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 说明 |
|--|--|------|
| userid | ID | 用户的ID。
[属性行为](/manual/api/reference_commentary#属性行为):
- *必填* |
| permission | integer | 权限级别的类型。
可能的值：
2 - 只读；
3 - 读写。
[属性行为](/manual/api/reference_commentary#属性行为):
- *必填* |
[comment]: # ({/cc6bb7e5-d34afa0c})