更新

更新

描述

object dashboard.update(object/array dashboards)

此方法允许更新已有的仪表盘。

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

参数

(object/array) 要更新的仪表盘属性。

必须为每个仪表盘定义 dashboardid 属性，其它的属性都是可选的。只有指定的属性会被更新，其它属性都将保持不变。

除了标准仪表盘属性以外，此方法还接受如下参数：

属性	类型	说明
pages	array	更新的仪表盘页面。仪表盘页面由`dashboard_pageid`属性更新。将为没有`dashboard_pageid`属性的对象创建新的仪表盘页面，如果不重新使用，现有仪表盘页面将被删除。仪表盘页面的顺序将与指定的顺序相同。只会更新仪表盘页面的指定属性。“pages”属性至少需要一个仪表盘页面对象。
users	array	更新的仪表盘用户。
userGroups	array	更新的仪表盘用户组。

返回值

(object) 返回一个对象，该对象包含 dashboardids属性下更新的仪表盘 ID。

示例

重命名一个仪表盘

重命名一个仪表盘为 “SQL server status”。

请求：

{
           "jsonrpc": "2.0",
           "method": "dashboard.update",
           "params": {
               "dashboardid": "2",
               "name": "SQL server status"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应：

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

更新仪表盘页面

重命名第一个仪表盘页面，替换第二个仪表盘页面上的部件，并添加一个新页面作为第三个页面。删除所有其他仪表盘页面。

请求：

{
           "jsonrpc": "2.0",
           "method": "dashboard.update",
           "params": {
               "dashboardid": "2",
               "pages": [
                   {
                       "dashboard_pageid": 1,
                       "name": 'Renamed Page'
                   },
                   {
                       "dashboard_pageid": 2,
                       "widgets": [
                           {
                               "type": "clock",
                               "x": 0,
                               "y": 0,
                               "width": 4,
                               "height": 3
                           }
                       ]
                   },
                   {
                       "display_period": 60
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应：

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

变更仪表盘所有者

仅适用于管理员以及超级管理员用户。

请求：

{
           "jsonrpc": "2.0",
           "method": "dashboard.update",
           "params": {
               "dashboardid": "2",
               "userid": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 2
       }

响应：

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

参阅

来源

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