Documentation
Table of Contents
dashboard.get
描述
integer/array dashboard.get(object parameters)该方法允许根据给定的参数检索仪表板。
此方法适用于任何类型的用户。可以在用户角色设置中撤销调用此方法的权限。更多信息请参见 User roles。
参数
(object) 定义期望输出的参数。
该方法支持以下参数。
| 参数 | 数据类型 | 说明 |
|---|---|---|
| dashboardids | ID/array | 仅返回具有指定ID的仪表板。 |
| selectPages | query | 返回一个包含仪表板页面的pages属性，并按正确顺序排列。 |
| selectUsers | query | 返回一个包含共享该仪表板的用户的users属性。 |
| selectUserGroups | query | 返回一个包含共享该仪表板的用户组的userGroups属性。 |
| sortfield | string/array | 按照指定属性对结果进行排序。 可能的值： dashboardid。 |
| countOutput | boolean | 这些参数在通用get方法参数中进行了描述。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
返回值
(integer/array) 返回以下之一：
- array 的 objects；
- 如果使用了
countOutput参数，则为检索到的 objects 的数量。
示例
按 ID 获取仪表板
检索关于仪表板 "1" 和 "2" 的所有数据。
执行请求:
{ "jsonrpc": "2.0", "method": "dashboard.get", "params": { "output": "extend", "selectPages": "extend", "selectUsers": "extend", "selectUserGroups": "extend", "dashboardids": [ "1", "2" ] }, "id": 1 }响应:
{ "jsonrpc": "2.0", "result": [ { "dashboardid": "1", "name": "Dashboard", "userid": "1", "private": "0", "display_period": "30", "auto_start": "1", "users": [], "userGroups": [], "pages": [ { "dashboard_pageid": "1", "name": "", "display_period": "0", "widgets": [ { "widgetid": "9", "type": "systeminfo", "name": "", "x": "12", "y": "8", "width": "12", "height": "5", "view_mode": "0", "fields": [] }, { "widgetid": "8", "type": "problemsbysv", "name": "", "x": "12", "y": "4", "width": "12", "height": "4", "view_mode": "0", "fields": [] }, { "widgetid": "7", "type": "problemhosts", "name": "", "x": "12", "y": "0", "width": "12", "height": "4", "view_mode": "0", "fields": [] }, { "widgetid": "6", "type": "discovery", "name": "", "x": "6", "y": "9", "width": "18", "height": "4", "view_mode": "0", "fields": [] }, { "widgetid": "5", "type": "web", "name": "", "x": "0", "y": "9", "width": "18", "height": "4", "view_mode": "0", "fields": [] }, { "widgetid": "4", "type": "problems", "name": "", "x": "0", "y": "3", "width": "12", "height": "6", "view_mode": "0", "fields": [] }, { "widgetid": "3", "type": "favmaps", "name": "", "x": "8", "y": "0", "width": "12", "height": "3", "view_mode": "0", "fields": [] }, { "widgetid": "1", "type": "favgraphs", "name": "", "x": "0", "y": "0", "width": "12", "height": "3", "view_mode": "0", "fields": [] } ] }, { "dashboard_pageid": "2", "name": "", "display_period": "0", "widgets": [] }, { "dashboard_pageid": "3", "name": "Custom page name", "display_period": "60", "widgets": [] } ] }, { "dashboardid": "2", "name": "My dashboard", "userid": "1", "private": "1", "display_period": "60", "auto_start": "1", "users": [ { "userid": "4", "permission": "3" } ], "userGroups": [ { "usrgrpid": "7", "permission": "2" } ], "pages": [ { "dashboard_pageid": "4", "name": "", "display_period": "0", "widgets": [ { "widgetid": "10", "type": "problems", "name": "", "x": "0", "y": "0", "width": "12", "height": "5", "view_mode": "0", "fields": [ { "type": "2", "name": "groupids", "value": "4" } ] } ] } ] } ], "id": 1 }另请参阅
来源
CDashboard::get() 在 ui/include/classes/api/services/CDashboard.php 中。