dashboard.create

描述

object dashboard.create(object/array dashboards)

此方法允许创建新的仪表板。

该方法适用于所有类型的用户。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅User roles

参数

(object/array) 待创建的仪表盘。

仪表盘外, 该方法还接受以下参数。

参数 数据类型 描述
pages
(required)
array 为仪表盘创建的仪表板页面仪表盘页面。仪表盘页面将按照指定顺序排序。pages属性至少需要一个object仪表盘页面。
users array 在仪表盘上创建的仪表盘用户仪表盘共享。
userGroups array 在仪表盘上创建的dashboard-用户组仪表盘共享。

返回值

(object) 返回一个包含所创建仪表板ID的object,这些ID存储在dashboardids属性下。返回的ID顺序与传入的仪表板顺序一致。

示例

创建仪表板

创建一个名为"我的仪表板"的仪表板,其中包含一个带标签的问题部件,并在单个仪表板页面上使用两种共享类型(用户组和用户)。

请求:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "problems",
                               "x": 0,
                               "y": 0,
                               "width": 12,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 1,
                                       "name": "tags.tag.0",
                                       "value": "service"
                                   },
                                   {
                                       "type": 0,
                                       "name": "tags.operator.0",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "tags.value.0",
                                       "value": "zabbix_server"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": "7",
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": "4",
                       "permission": 3
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "2"
               ]
           },
           "id": 1
       }

另请参阅

来源

CDashboard::create() 方法位于 ui/include/classes/api/services/CDashboard.php 文件中。