创建

说明

object dashboard.create(object/array dashboards)

此方法用于创建新的仪表盘。

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

参数

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

除了标准仪表板属性之外, 该方法还接受以下参数。

参数 类型 说明
pages array 要为仪表板创建的仪表板页面。仪表板页面将按照指定的顺序进行排序。

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

返回值

(object) 返回一个对象,该对象包含 dashboardids 属性, 代表新创建的仪表盘的 ID。返回值中 ID 的顺序与所传递的仪表盘的顺序相匹配。

示例

创建一个仪表盘

创建一个名为 "My dashboard" 的仪表盘,仪表盘中包含一个带有标签的问题组件,并使用了两种类型的共享(用户组和用户)。

请求:

{
    "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
}

另请参阅

来源

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