dashboard.create

描述

object dashboard.create(object/array dashboards)

此方法用于 create 新仪表板。

此方法可供任何类型的用户使用。可以在用户角色设置中撤销调用该方法的权限。 更多信息请参见 User roles

参数

(object/array) 要创建的仪表板。

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

参数 数据类型 描述
pages array 要为仪表板创建的仪表板页面。仪表板页面的顺序将与指定顺序一致。

参数行为:
- 必填
users array 要在仪表板上创建的仪表盘用户共享。
userGroups array 要在仪表板上创建的dashboard-用户组共享。

返回值

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

示例

创建仪表板

创建一个名为“My dashboard”的仪表板,在单个仪表板页面上添加一个带有标签的Problems小部件get,并使用两种共享类型(用户组和用户)。

执行请求:

{
           "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": 36,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 1,
                                       "name": "tags.0.tag",
                                       "value": "service"
                                   },
                                   {
                                       "type": 0,
                                       "name": "tags.0.operator",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "tags.0.value",
                                       "value": "zabbix_server"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": "7",
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": "4",
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

响应:

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

另请参阅

来源

CDashboard::create() 在 ui/include/classes/api/services/CDashboard.php 中。