创建一个仪表板¶
POST /api/v1/dashboards/create
概述¶
创建一个空仪表板,或者是根据仪表板模板
创建一个仪表板
规则:
- 参数中的name
字段将覆盖templateInfo
中的title
Body 请求参数¶
参数名 | 类型 | 必选 | 说明 |
---|---|---|---|
name | string | Y | 仪表板名称 允许为空: False 最大长度: 128 |
desc | string | 描述 例子: 描述1 允许为空: False 允许为空字符串: True 最大长度: 2048 |
|
extend | json | 仪表板的额外数据, 默认为{} 例子: {} 允许为空: False |
|
mapping | array | 视图变量的字段映射信息,默认为 [] 例子: [{'class': 'host_processes', 'field': 'create_time', 'mapping': 'username', 'datasource': 'object'}] 允许为空: False |
|
tagNames | array | 关联的 tag 列表 允许为空: False |
|
templateInfo | json | 仪表板模板数据 例子: {} 允许为空: False 允许为空字符串: False |
|
specifyDashboardUUID | string | 指定新建仪表板的uuid, 必须以dsbd_custom_ 为前缀后接 32 位长度的小写字母数字例子: dsbd_custom_xxxx32 允许为空: False 允许为空字符串: False $matchRegExp: ^dsbd_custom_[a-z0-9]{32}$ |
|
isPublic | int | 是否公开展示, 1为公开, 0为非公开, -1表示自定义 例子: 1 允许为空: False |
|
openPermissionSet | boolean | 2024-11-27 迭代 废弃该字段,不再生效. 后续使用 isPublic 为-1 表示 开启自定义权限配置 允许为空: False |
|
permissionSet | array | 自定义时 isPublic 为-1时候的 操作权限配置, 可配置(角色(除拥有者), 成员uuid, 团队uuid) 例子: ['wsAdmin', 'acnt_xxxx', 'group_yyyy'] 允许为空: False |
|
readPermissionSet | array | 自定义时 isPublic 为-1时候的 读取权限配置, 可配置(角色(除拥有者), 成员uuid, 团队uuid) 例子: ['wsAdmin', 'acnt_xxxx', 'group_yyyy'] 允许为空: False |
参数补充说明¶
参数说明:
模板的基础结构组成包含: 视图结构(含图表结构, 视图变量结构,图表分组结构)
templateInfo
的主体结构说明
参数名 | type | 必选 | 说明 |
---|---|---|---|
title | string | 必须 | 视图标题名称 |
summary | string | 模板的摘要信息 | |
dashboardType | string | 已废弃,默认为CUSTOM |
|
dashboardExtend | json | 视图额外数据信息 | |
dashboardMapping | array[json] | 视图变量的字段映射配置列表 | |
iconSet | json | 仪表版图标信息 | |
iconSet.url | json | 仪表版中等图标链接地址 | |
iconSet.icon | json | 仪表版小图标链接地址 | |
icon | string | 仪表版小图标文件名 | |
thumbnail | string | 仪表版中等图标文件名 | |
main | json | 仪表板内容结构 | |
main.type | string | 模板类型, 该字段为系统字段,可忽略 | |
main.vars | array[json] | 视图变量配置列表 | |
main.vars[#] | json | 视图变量配置结构 | |
main.groups | array[string] | 图表分组名列表 | |
main.charts | array[json] | 视图的图表配置列表 | |
main.charts[#] | json | 图表配置结构 |
dashboardMapping[#]
的主体结构说明
参数名 | type | 必选 | 说明 |
---|---|---|---|
main.charts[#]
的主体结构说明
参数名 | type | 必选 | 说明 |
---|---|---|---|
name | string | 必须 | 图表名字 |
type | string | 必须 | 图表类型 |
pos | json | 图表的位置结构 | |
pos.i | string | ||
pos.h | string | 高度 | |
pos.w | string | 宽度 | |
pos.x | string | x轴坐标 | |
pos.y | string | y轴坐标 | |
group | json[string] | 分组信息 | |
group.name | string | 分组名, 没有分组是允许为 null | |
queries | array[json] | 必须 | 图表查询查询语句结构列表 |
**时序图表
结构 main.charts[#].type=sequence
其主体结构参数如下: **
参数名 | type | 必选 | 说明 |
---|---|---|---|
name | string | 必须 | 图表名字 |
type | string | 必须 | 图表类型 |
pos | string | 必须 | 图表类型 |
queries | array[json] | 必须 | 图表查询查询语句结构列表 |
main.vars[#]
的主体结构说明
参数名 | type | 必选 | 说明 |
---|---|---|---|
请求例子¶
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": "请求数", "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-链路资源"}}' \
--compressed
响应¶
{
"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 监控视图-lwctest",
"ownerType": "node",
"status": 0,
"tag_info": [
{
"id": "tag_xxxx32",
"name": "测试"
}
],
"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"
}