获取

说明

integer/array dashboard.get(object parameters)

此方法用于通过指定的参数获取仪表盘信息。

此方法任何类型的用户都可以使用。可以在用户角色设置中撤销用户调用该方法的权限。更多信息请查看用户角色

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数 类型 描述
dashboardids ID/数组 仅返回具有给定ID的仪表盘。
selectPages 查询 返回一个pages属性,其中包含仪表盘页面,顺序正确。
selectUsers 查询 返回一个users属性,其中包含与仪表盘共享的用户。
selectUserGroups 查询 返回一个userGroups属性,其中包含与仪表盘共享的用户组。
sortfield 字符串/数组 根据给定属性对结果进行排序。

可能的值:dashboardid
countOutput 布尔值 这些参数在参考说明中进行了描述。
editable 布尔值
excludeSearch 布尔值
filter 对象
limit 整数
output 查询
preservekeys 布尔值
search 对象
searchByAny 布尔值
searchWildcardsEnabled 布尔值
sortorder 字符串/数组
startSearch 布尔值

返回值

(integer/array) 返回值存在以下两种可能:

  • 一个对象数组;
  • 如果指定 countOutput 参数,则返回获取到的仪表盘数量。

示例

通过 ID 获取仪表盘

获取 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
       }

参考

来源

ui/include/classes/api/services/CDashboard.php 中的 CDashboard::get()