获取

说明

integer/array dashboard.get(object parameters)

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

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

参数

(object) 定义返回值内容。

此方法支持以下参数：

参数类型说明
dashboardidsID/array只返回给定 ID 的仪表盘的信息。
selectPagesquery返回一个包含正确排序的仪表盘页面的 pages 属性。
selectUsersquery返回一个包含仪表盘用户的 users属性。
selectUserGroupsquery返回一个包含仪表盘用户组的 userGroups属性。
sortfieldstring/array通过指定属性对结果进行排序。

可用值: dashboardid
countOutputboolean这些参数是所有 get 方法的公共参数，更多信息请查看 参考说明页面。
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

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

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

示例

通过 ID 获取仪表盘

获取 ID 为 1 或 2 的仪表盘的所有数据。

请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "dashboard.get",
  4.            "params": {
  5.                "output": "extend",
  6.                "selectPages": "extend",
  7.                "selectUsers": "extend",
  8.                "selectUserGroups": "extend",
  9.                "dashboardids": [
  10.                    "1",
  11.                    "2"
  12.                ]
  13.            },
  14.            "id": 1
  15.        }

响应:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": [
  4.                {
  5.                    "dashboardid": "1",
  6.                    "name": "Dashboard",
  7.                    "userid": "1",
  8.                    "private": "0",
  9.                    "display_period": "30",
  10.                    "auto_start": "1",
  11.                    "users": [],
  12.                    "userGroups": [],
  13.                    "pages": [
  14.                        {
  15.                            "dashboard_pageid": "1",
  16.                            "name": "",
  17.                            "display_period": "0",
  18.                            "widgets": [
  19.                                {
  20.                                    "widgetid": "9",
  21.                                    "type": "systeminfo",
  22.                                    "name": "",
  23.                                    "x": "12",
  24.                                    "y": "8",
  25.                                    "width": "12",
  26.                                    "height": "5",
  27.                                    "view_mode": "0",
  28.                                    "fields": []
  29.                                },
  30.                                {
  31.                                    "widgetid": "8",
  32.                                    "type": "problemsbysv",
  33.                                    "name": "",
  34.                                    "x": "12",
  35.                                    "y": "4",
  36.                                    "width": "12",
  37.                                    "height": "4",
  38.                                    "view_mode": "0",
  39.                                    "fields": []
  40.                                },
  41.                                {
  42.                                    "widgetid": "7",
  43.                                    "type": "problemhosts",
  44.                                    "name": "",
  45.                                    "x": "12",
  46.                                    "y": "0",
  47.                                    "width": "12",
  48.                                    "height": "4",
  49.                                    "view_mode": "0",
  50.                                    "fields": []
  51.                                },
  52.                                {
  53.                                    "widgetid": "6",
  54.                                    "type": "discovery",
  55.                                    "name": "",
  56.                                    "x": "6",
  57.                                    "y": "9",
  58.                                    "width": "18",
  59.                                    "height": "4",
  60.                                    "view_mode": "0",
  61.                                    "fields": []
  62.                                },
  63.                                {
  64.                                    "widgetid": "5",
  65.                                    "type": "web",
  66.                                    "name": "",
  67.                                    "x": "0",
  68.                                    "y": "9",
  69.                                    "width": "18",
  70.                                    "height": "4",
  71.                                    "view_mode": "0",
  72.                                    "fields": []
  73.                                },
  74.                                {
  75.                                    "widgetid": "4",
  76.                                    "type": "problems",
  77.                                    "name": "",
  78.                                    "x": "0",
  79.                                    "y": "3",
  80.                                    "width": "12",
  81.                                    "height": "6",
  82.                                    "view_mode": "0",
  83.                                    "fields": []
  84.                                },
  85.                                {
  86.                                    "widgetid": "3",
  87.                                    "type": "favmaps",
  88.                                    "name": "",
  89.                                    "x": "8",
  90.                                    "y": "0",
  91.                                    "width": "12",
  92.                                    "height": "3",
  93.                                    "view_mode": "0",
  94.                                    "fields": []
  95.                                },
  96.                                {
  97.                                    "widgetid": "1",
  98.                                    "type": "favgraphs",
  99.                                    "name": "",
  100.                                    "x": "0",
  101.                                    "y": "0",
  102.                                    "width": "12",
  103.                                    "height": "3",
  104.                                    "view_mode": "0",
  105.                                    "fields": []
  106.                                }
  107.                            ]
  108.                        },
  109.                        {
  110.                            "dashboard_pageid": "2",
  111.                            "name": "",
  112.                            "display_period": "0",
  113.                            "widgets": []
  114.                        },
  115.                        {
  116.                            "dashboard_pageid": "3",
  117.                            "name": "Custom page name",
  118.                            "display_period": "60",
  119.                            "widgets": []
  120.                        }
  121.                    ]
  122.                },
  123.                {
  124.                    "dashboardid": "2",
  125.                    "name": "My dashboard",
  126.                    "userid": "1",
  127.                    "private": "1",
  128.                    "display_period": "60",
  129.                    "auto_start": "1",
  130.                    "users": [
  131.                        {
  132.                            "userid": "4",
  133.                            "permission": "3"
  134.                        }
  135.                    ],
  136.                    "userGroups": [
  137.                        {
  138.                            "usrgrpid": "7",
  139.                            "permission": "2"
  140.                        }
  141.                    ],
  142.                    "pages": [
  143.                        {
  144.                            "dashboard_pageid": "4",
  145.                            "name": "",
  146.                            "display_period": "0",
  147.                            "widgets": [
  148.                                {
  149.                                    "widgetid": "10",
  150.                                    "type": "problems",
  151.                                    "name": "",
  152.                                    "x": "0",
  153.                                    "y": "0",
  154.                                    "width": "12",
  155.                                    "height": "5",
  156.                                    "view_mode": "0",
  157.                                    "fields": [
  158.                                        {
  159.                                            "type": "2",
  160.                                            "name": "groupids",
  161.                                            "value": "4"
  162.                                        }
  163.                                    ]
  164.                                }
  165.                            ]
  166.                        }
  167.                    ]
  168.                }
  169.            ],
  170.            "id": 1
  171.        }

参考

来源

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