Create a Dashboard¶

POST /api/v1/dashboards/create

Overview¶

Create an empty dashboard, or create a dashboard based on a dashboard template. Rules: - The name field in the parameters will override the title in templateInfo

Body Request Parameters¶

Parameter Name	Type	Required	Description
name	string	Y	Dashboard name Allow null: False Maximum length: 128
desc	string		Description Example: Description1 Allow null: False Allow empty string: True Maximum length: 2048
identifier	string		Identifier ID -- Added on 2024.12.25 Example: xxxx Allow null: False Allow empty string: True Maximum length: 128
extend	json		Additional data for the dashboard, defaults to {} Example: {} Allow null: False
mapping	array		Field mapping information for view variables, defaults to [] Example: [{'class': 'host_processes', 'field': 'create_time', 'mapping': 'username', 'datasource': 'object'}] Allow null: False
tagNames	array		List of associated tags Allow null: False
templateInfo	json		Dashboard template data Example: {} Allow null: False Allow empty string: False
specifyDashboardUUID	string		Specify the UUID for the new dashboard, must start with `dsbd_custom_` followed by 32 lowercase letters or numbers Example: dsbd_custom_xxxx32 Allow null: False Allow empty string: False $matchRegExp: ^dsbd_custom_[a-z0-9]{32}$
isPublic	int		Whether it is publicly displayed, 1 for public, 0 for private, -1 indicates custom Example: 1 Allow null: False
openPermissionSet	boolean		Deprecated as of 2024-11-27, no longer effective. Use `isPublic` set to -1 to indicate custom permission configuration. Allow null: False
permissionSet	array		Custom operation permission configuration when `isPublic` is -1, can configure (role (except owner), member UUID, team UUID) Example: ['wsAdmin', 'acnt_xxxx', 'group_yyyy'] Allow null: False
readPermissionSet	array		Custom read permission configuration when `isPublic` is -1, can configure (role (except owner), member UUID, team UUID) Example: ['wsAdmin', 'acnt_xxxx', 'group_yyyy'] Allow null: False

Parameter Supplemental Explanation¶

Parameter description:

The basic structure of the template includes: view structure (including chart structure, view variable structure, chart grouping structure)

templateInfo main structure explanation

Parameter Name	type	Required	Description
title	string	Required	View title name
summary	string		Template summary information
identifier	string		Template identifier ID -- Added on 2024.12.25
dashboardType	string		Deprecated, defaults to `CUSTOM`
dashboardExtend	json		Additional data information for the view
dashboardMapping	array[json]		Configuration list for view variable field mappings
iconSet	json		Dashboard icon information
iconSet.url	json		URL address for medium-sized icons in the dashboard
iconSet.icon	json		URL address for small icons in the dashboard
icon	string		Small icon filename for the dashboard
thumbnail	string		Medium-sized icon filename for the dashboard
main	json		Dashboard content structure
main.type	string		Template type, this field is a system field and can be ignored
main.vars	array[json]		View variable configuration list
main.vars[#]	json		View variable configuration structure
main.groups	array[string]		List of chart group names
main.charts	array[json]		View chart configuration list
main.charts[#]	json		Chart configuration structure

dashboardMapping[#] main structure explanation

Parameter Name	type	Required	Description

main.charts[#] main structure explanation

Parameter Name	type	Required	Description
name	string	Required	Chart name
type	string	Required	Chart type
pos	json		Chart position structure
pos.i	string
pos.h	string		Height
pos.w	string		Width
pos.x	string		X-axis coordinate
pos.y	string		Y-axis coordinate
group	json[string]		Group information
group.name	string		Group name, can be null if no group
queries	array[json]	Required	List of chart query statement structures

**For Time Series Charts structure main.charts[#].type=sequence, the main structure parameters are as follows: **

Parameter Name	type	Required	Description
name	string	Required	Chart name
type	string	Required	Chart type
pos	string	Required	Chart type
queries	array[json]	Required	List of chart query statement structures

main.vars[#] main structure explanation

Parameter Name	type	Required	Description

Request Example¶

curl 'https://openapi.guance.com/api/v1/dashboards/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name": "x5T8APwi", "templateInfo": {"dashboardBindSet": [], "dashboardExtend": {}, "dashboardMapping": [], "dashboardOwnerType": "node", "dashboardType": "CUSTOM", "iconSet": {}, "main": {"charts": [{"extend": {"settings": {"chartType": "bar", "colors": [{"color": "#3ab8ff", "key": "count(trace_id){\"status\": \"ok\"}"}, {"color": "#f97575", "key": "count(trace_id){\"status\": \"error\"}"}], "openStack": true, "options": {"yAxis": {"axisLabel": {"color": "#666"}, "axisLine": {"show": true}, "axisTick": {"show": false}, "splitLine": {"show": false}, "splitNumber": 1}}, "xAxisShowType": "time"}}, "group": {"name": null}, "name": "Request Count", "pos": null, "queries": [{"checked": true, "datasource": "dataflux", "qtype": "dql", "query": {"density": "lower", "filter": [{"logic": "and", "name": "service", "op": "=", "value": "front-api"}], "groupBy": " by `status`", "groupByTime": "auto", "q": "T::re(`.*`):(count(`trace_id`)){ `service` = 'front-api' } [::auto] by `status`"}, "unit": "", "uuid": "6aed3c00-7a99-11ec-8689-536665ee3a48"}], "type": "sequence"}], "groups": [], "type": "template", "vars": []}, "summary": "", "tagInfo": [], "tags": [], "thumbnail": "", "title": "lwc-Link Resource"}}' \
--compressed

Response¶

{
    "code": 200,
    "content": {
        "chartGroupPos": [],
        "chartPos": [
            {
                "chartUUID": "chrt_xxxx32",
                "pos": {
                    "h": 9,
                    "i": 0,
                    "w": 8,
                    "x": 0,
                    "y": 0
                }
            },
            {
                "chartUUID": "chrt_xxxx32",
                "pos": {
                    "h": 9,
                    "i": 1,
                    "w": 8,
                    "x": 0,
                    "y": 9
                }
            },
            {
                "chartUUID": "chrt_xxxx32",
                "pos": {
                    "h": 9,
                    "i": 2,
                    "w": 8,
                    "x": 8,
                    "y": 0
                }
            },
            {
                "chartUUID": "chrt_xxxx32",
                "pos": {
                    "h": 9,
                    "i": 3,
                    "w": 8,
                    "x": 16,
                    "y": 0
                }
            },
            {
                "chartUUID": "chrt_xxxx32",
                "pos": {
                    "h": 9,
                    "i": 4,
                    "w": 8,
                    "x": 8,
                    "y": 9
                }
            },
            {
                "chartUUID": "chrt_xxxx32",
                "pos": {
                    "h": 9,
                    "i": 5,
                    "w": 8,
                    "x": 16,
                    "y": 9
                }
            }
        ],
        "createAt": 1641953280.0015242,
        "createdWay": "manual",
        "creator": "acnt_xxxx32",
        "dashboardBindSet": [],
        "deleteAt": -1,
        "extend": {},
        "iconSet": {
            "icon": "http://testing-static-res.cloudcare.cn/dataflux-template/dashboard/cpu/icon.svg",
            "url": "http://testing-static-res.cloudcare.cn/dataflux-template/dashboard/cpu/cpu.png"
        },
        "id": null,
        "mapping": [],
        "name": "CPU Monitoring View-lwctest",
        "ownerType": "node",
        "status": 0,
        "tag_info": [
            {
                "id": "tag_xxxx32",
                "name": "Test"
            }
        ],
        "type": "CUSTOM",
        "updateAt": 1641953280.0015464,
        "updator": "acnt_xxxx32",
        "uuid": "dsbd_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-97C1194E-40E6-43A3-B6DF-6637D96BECDB"
}