大屏
更新时间:2025-07-01
获取大屏树形目录列表
接口简介
获取某空间所有大屏树形目录列表
接口详情
请求地址
/openapi/v2/group/{groupKey}/dashboard
请求类型
GET
请求参数
无
返回正确 JSON 示例
Javascript
1{
2 "data": [
3 {
4 "hash": "d_ada15-8tkyaopy-wkx6ky",
5 "name": "大屏1",
6 "remark": "用户10创建的",
7 "type": 1,
8 "orderIndex": 1,
9 "isTemplet": false,
10 "authType": 0,
11 "isPublic": false,
12 "isPub": true,
13 "isDev": false
14 },
15 {
16 "hash": "d_ada15-5cuhym18-pm192o",
17 "name": "b创建的大屏",
18 "remark": "用户18创建的",
19 "type": 1,
20 "orderIndex": 2,
21 "isTemplet": false,
22 "authType": 0,
23 "isPublic": false,
24 "isPub": false,
25 "isDev": false
26 },
27 {
28 "hash": "d_ada15-7p39wnhu-bk7jkq",
29 "name": "大屏3",
30 "remark": "",
31 "type": 1,
32 "orderIndex": 3,
33 "isTemplet": false,
34 "authType": 0,
35 "isPublic": false,
36 "isPub": false,
37 "isDev": false
38 },
39 {
40 "hash": "d_ada15-3enqwwgj-wko9k3",
41 "name": "大屏文件夹",
42 "remark": "",
43 "type": 0,
44 "children": [
45 {
46 "hash": "d_ada15-6awllf72-5294mr",
47 "name": "文件夹中第一个",
48 "remark": "",
49 "type": 1,
50 "orderIndex": 1,
51 "isTemplet": false,
52 "authType": 0,
53 "isPublic": false,
54 "isPub": false,
55 "isDev": false
56 },
57 {
58 "hash": "d_ada15-bu7zfuwr-xmrpk1",
59 "name": "文件夹中文件夹",
60 "remark": "",
61 "type": 0,
62 "children": [
63 {
64 "hash": "d_ada15-clph4g7r-ekl426",
65 "name": "II_大屏",
66 "remark": "",
67 "type": 1,
68 "orderIndex": 1,
69 "isTemplet": false,
70 "authType": 0,
71 "isPublic": false,
72 "isPub": false,
73 "isDev": false
74 }
75 ],
76 "orderIndex": 2,
77 "isTemplet": false,
78 "authType": 0,
79 "isPublic": false,
80 "isPub": false,
81 "isDev": false
82 }
83 ],
84 "orderIndex": 4,
85 "isTemplet": false,
86 "authType": 0,
87 "isPublic": false,
88 "isPub": true,
89 "isDev": false
90 }
91 ]
92}
返回错误 JSON 示例
Javascript
1{
2 msg: '错误详情',
3 status:499
4}
请求示例
某用户有权限查看的大屏树形列表
接口简介
某用户有权限查看的大屏树形列表
接口详情
请求地址
/openapi/v2/group/{groupKey}/dashboard/dashboardOfUser
请求类型
GET
请求参数
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
userEmail | String | 是 | 用户账号邮箱 | - | a@baidu.com |
返回正确 JSON 示例
Javascript
1{
2 "data": [
3 {
4 "hash": "d_ada15-8tkyaopy-wkx6ky",
5 "name": "大屏1",
6 "remark": "用户10创建的",
7 "type": 1,
8 "orderIndex": 1,
9 "isTemplet": false,
10 "authType": 0,
11 "isPublic": false,
12 "isPub": true,
13 "isDev": false
14 },
15 {
16 "hash": "d_ada15-5cuhym18-pm192o",
17 "name": "b创建的大屏",
18 "remark": "用户2创建的",
19 "type": 1,
20 "orderIndex": 2,
21 "isTemplet": false,
22 "authType": 0,
23 "isPublic": false,
24 "isPub": false,
25 "isDev": false
26 },
27 {
28 "hash": "d_ada15-7p39wnhu-bk7jkq",
29 "name": "大屏3",
30 "remark": "",
31 "type": 1,
32 "orderIndex": 3,
33 "isTemplet": false,
34 "authType": 0,
35 "isPublic": false,
36 "isPub": false,
37 "isDev": false
38 },
39 {
40 "hash": "d_ada15-3enqwwgj-wko9k3",
41 "name": "大屏文件夹",
42 "remark": "",
43 "type": 0,
44 "children": [
45 {
46 "hash": "d_ada15-6awllf72-5294mr",
47 "name": "I-大屏test",
48 "remark": "",
49 "type": 1,
50 "orderIndex": 1,
51 "isTemplet": false,
52 "authType": 0,
53 "isPublic": false,
54 "isPub": false,
55 "isDev": false
56 },
57 {
58 "hash": "d_ada15-bu7zfuwr-xmrpk1",
59 "name": "文件夹中文件夹",
60 "remark": "",
61 "type": 0,
62 "children": [
63 {
64 "hash": "d_ada15-clph4g7r-ekl426",
65 "name": "IIS大屏",
66 "remark": "",
67 "type": 1,
68 "orderIndex": 1,
69 "isTemplet": false,
70 "authType": 0,
71 "isPublic": false,
72 "isPub": false,
73 "isDev": false
74 }
75 ],
76 "orderIndex": 2,
77 "isTemplet": false,
78 "authType": 0,
79 "isPublic": false,
80 "isPub": false,
81 "isDev": false
82 }
83 ],
84 "orderIndex": 4,
85 "isTemplet": false,
86 "authType": 0,
87 "isPublic": false,
88 "isPub": true,
89 "isDev": false
90 }
91 ]
92}
返回错误 JSON 示例
Javascript
1{
2 msg: '错误详情',
3 status:499
4}
请求示例
导入图表创建大屏
接口简介
基于大屏配置 json 和图表配置 json 创建大屏,并将大屏发布为 token 分享状态,返回大屏地址和带 token 鉴权的分享链接
接口详情
请求地址
/openapi/v2/group/transmit/dashboard/createDashboard
请求类型
POST
请求参数
Javascript
1 {
2 "authType": "3", // 选填,分享类型(0:停止分享,1:公开分享,2:加密公开分享,3:通过Token验证)不传就表示不公开分享,这时返回的url就变成需要登录访问的那种url
3 "password":"111", // 选填,分享密码(authType=2时必须传)
4 "sugar_sign_token": "dsfsdfds", // 选填,加入签名的参数,用户指定,注意需要以sugar_sign开头
5 "validTime": "5", // 选填,有效期(单位:小时),不传默认1分钟有效
6 "groupHash":"g_ada15-813h0cm6-p284kv", // 必填,空间hash
7 "name": "大屏创建测试", // 必填,大屏名称
8 "userEmail": "zhangsan@baidu.com", // 必填,创建者邮箱
9 "dashboard": "{\"dashboard\":{\"config\":{\"comment\":{\"boxTextColor\":\"#fff\"},\"backgroundType\":0,\"backgroundUrl\":\"/static/img-templet/background-4.png\",\"theme\":\"blue\",\"grid\":5,\"backgroundBlur\":0,\"backgroundOpacity\":10,\"backgroundColor\":\"rgba(0, 0, 0, 1)\",\"hasSave\":true,\"ut\":14},\"width\":\"1920\",\"height\":\"1080\",\"parent_hash\":\"\",\"icon\":\"\",\"remark\":\"\",\"scale_type\":\"\",\"is_dev\":\"\",\"is_pub\":\"\",\"charts\":[{\"config\":{\"shadowBlur\":4,\"chartZoom\":{\"open\":true,\"chartSize\":\"auto\",\"centering\":\"center\",\"dialogSize\":\"full\"},\"legendScroll\":true,\"chartLegend\":true,\"legendHeight\":20,\"legendWidth\":55,\"dataZoomStart\":60,\"dataZoomEnd\":100,\"dataZoomStartValue\":1,\"dataZoomEndValue\":10,\"marginLeft\":70,\"marginTop\":20,\"marginRight\":35,\"marginBottom\":55,\"defaultLegendCount\":0,\"barMaxWidth\":16,\"barBorderRadius\":0,\"markLineVal\":0,\"yType\":\"normal\",\"secondYType\":\"normal\",\"xLabelRotate\":-25,\"hideYSplitArea\":true,\"areaStyleLinearColor\":false,\"areaOpacity\":50,\"slideInterval\":3,\"chartStepType\":\"start\",\"tlAxisType\":\"category\",\"tlAutoPlay\":true,\"tlPlayInterval\":6,\"tlItemStyleColor\":\"#bbb\",\"tlLineStyleColor\":\"#fff\",\"tlControlStyleColor\":\"#666\",\"tlControlStyleBorderColor\":\"#fff\",\"tlSymbol\":\"circle\",\"tlSymbolColor\":\"#bbb\",\"tlEmphasisColor\":\"#177cdc\",\"tlNormalColor\":\"#fff\",\"tlShowNextBtn\":true,\"tlShowPlayBtn\":true,\"showGraphic\":true,\"isLock\":false,\"isHidden\":false,\"hideLoading\":true,\"opacity\":1,\"hideYSplitLine\":true,\"alignTicks\":true,\"mobile\":{\"width\":6,\"height\":300,\"left\":0,\"top\":300},\"mobileInitial\":{\"width\":6,\"height\":300,\"left\":0,\"top\":300}},\"data_config\":{\"continuity_type\":\"simple\",\"continuity_time_step\":\"1Hour\",\"continuity_empty_val\":\"1\",\"categoriesSort\":\"default\",\"doubleY\":false,\"timeline\":false,\"conAutoGroup\":true,\"needAutoRefresh\":true,\"autoRefreshInterval\":1800,\"cacheTTL\":-1,\"dataModel\":{\"limit\":10000,\"x\":[{\"frontendId\":\"FMBQCOMAX4N0PE\",\"id\":\"SGD26EDA15E7F17B2C\",\"type\":\"d\",\"dataType\":\"string\"}],\"y\":[{\"frontendId\":\"FMBQCOOYA2PYPD\",\"id\":\"SG3B1BA15B4CB48B58\",\"type\":\"m\",\"dataType\":\"int\"}]},\"tableAutoRatio\":{}},\"drill_down\":[],\"hash\":\"dc_ada15-a063jbdj-2wlyym\",\"frontend_id\":\"mboq1jx84bavy\",\"type\":\"line\",\"name\":\"折线图\",\"remark\":\"\",\"width\":550,\"height\":300,\"left_position\":200,\"top_position\":305,\"z_index\":52,\"refresh_intervel\":1000,\"data_type\":\"dataModel\",\"data_model_hash\":\"mld_ada15-32icev43-4nrw86r\",\"data_api_url\":\"${CUR_HOST}/openapi/demo/chart?type=line\",\"drill_down_open\":false,\"dd_model_hashs\":\"\"}],\"conditions\":[]}}"
10 // 必填,创建大屏的数据
11}
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
authType | String | 否 | 分享类型(0:停止分享,1:公开分享,2:加密公开分享,3:通过 Token 验证) | 0 | 3 |
password | String | 否 | 分享密码(authType=2 时必须传) | - | 12345 |
sugar_sign_token | String | 否 | 加入签名的参数 | - | abcde |
validTime | String | 否 | 有效期(单位:小时),不传默认 1 分钟有效 | - | 1-32 |
groupHash | String | 是 | 空间 hash | - | - |
name | String | 是 | 大屏名称 | - | - |
userEmail | String | 是 | 用户账号邮箱 | - | a@baidu.com |
dashboard | String | 是 | 创建大屏的数据,详情参考下面的 json,需要转义 | - | - |
Javascript
1{
2 "dashboard": {
3 "config": { //必填,大屏配置
4 "comment": {
5 "boxTextColor": "#fff"
6 },
7 "backgroundType": 0,
8 "backgroundUrl": "/static/img-templet/background-4.png",
9 "theme": "blue",
10 "grid": 5,
11 "backgroundBlur": 0,
12 "backgroundOpacity": 10,
13 "backgroundColor": "rgba(0, 0, 0, 1)",
14 "hasSave": true,
15 "ut": 14
16 },
17 "width": "1920", // 必填,大屏宽度
18 "height": "1080", // 必填,大屏高度
19 "parent_hash": "", // 选填,父级目录的hash,不传默认根目录
20 "icon": "", // 选填,图标
21 "remark": "", // 选填,简介
22 "scale_type": "", // 选填,默认3,展示缩放模式,0:全屏,1:宽度优先,2:高度优先,3: 等比缩放
23 "is_dev": "", // 选填,是否开发中
24 "is_pub": "", // 选填,是否公开
25 "charts": [{ // 必填,图表们
26 "config": {
27 "shadowBlur": 4,
28 "chartZoom": {
29 "open": true,
30 "chartSize": "auto",
31 "centering": "center",
32 "dialogSize": "full"
33 },
34 "legendScroll": true,
35 "chartLegend": true,
36 "legendHeight": 20,
37 "legendWidth": 55,
38 "dataZoomStart": 60,
39 "dataZoomEnd": 100,
40 "dataZoomStartValue": 1,
41 "dataZoomEndValue": 10,
42 "marginLeft": 70,
43 "marginTop": 20,
44 "marginRight": 35,
45 "marginBottom": 55,
46 "defaultLegendCount": 0,
47 "barMaxWidth": 16,
48 "barBorderRadius": 0,
49 "markLineVal": 0,
50 "yType": "normal",
51 "secondYType": "normal",
52 "xLabelRotate": -25,
53 "hideYSplitArea": true,
54 "areaStyleLinearColor": false,
55 "areaOpacity": 50,
56 "slideInterval": 3,
57 "chartStepType": "start",
58 "tlAxisType": "category",
59 "tlAutoPlay": true,
60 "tlPlayInterval": 6,
61 "tlItemStyleColor": "#bbb",
62 "tlLineStyleColor": "#fff",
63 "tlControlStyleColor": "#666",
64 "tlControlStyleBorderColor": "#fff",
65 "tlSymbol": "circle",
66 "tlSymbolColor": "#bbb",
67 "tlEmphasisColor": "#177cdc",
68 "tlNormalColor": "#fff",
69 "tlShowNextBtn": true,
70 "tlShowPlayBtn": true,
71 "showGraphic": true,
72 "isLock": false,
73 "isHidden": false,
74 "hideLoading": true,
75 "opacity": 1,
76 "hideYSplitLine": true,
77 "alignTicks": true,
78 "mobile": {
79 "width": 6,
80 "height": 300,
81 "left": 0,
82 "top": 300
83 },
84 "mobileInitial": {
85 "width": 6,
86 "height": 300,
87 "left": 0,
88 "top": 300
89 }
90 },
91 "data_config": {
92 "continuity_type": "simple",
93 "continuity_time_step": "1Hour",
94 "continuity_empty_val": "1",
95 "categoriesSort": "default",
96 "doubleY": false,
97 "timeline": false,
98 "conAutoGroup": true,
99 "needAutoRefresh": true,
100 "autoRefreshInterval": 1800,
101 "cacheTTL": -1,
102 "dataModel": {
103 "limit": 10000,
104 "x": [{
105 "frontendId": "FMBQCOMAX4N0PE",
106 "id": "SGF06793F8D87D5D62",
107 "type": "d",
108 "dataType": "string"
109 }],
110 "y": [{
111 "frontendId": "FMBQCOOYA2PYPD",
112 "id": "SG5BA7C6831D7A9625",
113 "type": "m",
114 "dataType": "int"
115 }]
116 },
117 "tableAutoRatio": {}
118 },
119 "drill_down": [],
120 "hash": "dc_ada15-a063jbdj-2wlyym",
121 "frontend_id": "mboq1jx84bavy",
122 "type": "line",
123 "name": "折线图",
124 "remark": "",
125 "width": 550,
126 "height": 300,
127 "left_position": 200,
128 "top_position": 305,
129 "z_index": 52,
130 "refresh_intervel": 1000,
131 "data_type": "dataModel",
132 "data_model_hash": "mld_ada15-bh2k1tki-zwywqyr",
133 "data_api_url": "${CUR_HOST}/openapi/demo/chart?type=line",
134 "drill_down_open": false,
135 "dd_model_hashs": ""
136 }], //图表配置
137 "conditions": [] // 选填,过滤条件配置
138 }
139}
返回正确 JSON 示例
Javascript
1{
2 status: 0,
3 msg: "创建成功",
4 data: {
5 "url":"https://sugar.bce.baidu.com/group/sugarTest/dashboard/d_1013e-10f8a39v-o8l4xm?__scp__=baidu.com" // 不传authType就表示不公开分享,这时返回的url就变成需要登录访问的那种url
6 "shareUrl":"https://sugar.baidubce.com/dashboard/1827981ec07ac66f937a88c9e65f****?_sugar_time=1612500688339&_sugar_signature=xM%2FNQv%2F5Je7o4j2046I0Gi%2BDmQegGn%2FEHXU%2BNskcEg****&sugar_sign_token=abcde"
7 // 传authType(1,2,3时)就表示大屏开启分享,这时返回的url就变成对应的分享链接,token方式是携带签名的shareUrl
8 },
9 patch: true
10}
返回错误 JSON 示例
Javascript
1{
2 msg: '错误详情',
3 status:499
4}
请求示例
获取已有大屏的分享链接并更新分享状态
接口简介
将空间内已有大屏进行公开分享,并获取分享链接
接口详情
请求地址
/openapi/v2/group/transmit/dashboard/publishDashboard
请求类型
POST
请求参数
Javascript
1 {
2 "authType": "3", // 选填,分享类型(0:停止分享,1:公开分享,2:加密公开分享,3:通过Token验证)不传就表示不公开分享,这时返回的url就变成需要登录访问的那种url
3 "password": "111", // 选填,分享密码(authType=2时必须传)
4 "sugar_sign_token": "fdsfsdfds", // 选填,加入签名的参数,用户指定,注意需要以sugar_sign开头
5 "validTime": "5", // 选填,有效期(单位:小时),不传默认1分钟有效
6 "dashboardHash": "d_1013e-cd2w03zt-k922g" // 必填,大屏hash
7}
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
authType | String | 否 | 分享类型(0:停止分享,1:公开分享,2:加密公开分享,3:通过 Token 验证) | 0 | 3 |
password | String | 否 | 分享密码(authType=2 时必须传) | - | 12345 |
sugar_sign_token | String | 否 | 加入签名的参数 | - | abcde |
validTime | String | 否 | 有效期(单位:小时),不传默认 1 分钟有效 | - | 1-32 |
dashboardHash | String | 是 | 大屏 hash | - | - |
返回正确 JSON 示例
Javascript
1{
2 status: 0,
3 msg: "创建成功",
4 data: {
5 "shareUrl":"https://sugar.baidubce.com/dashboard/1827981ec07ac66f937a88c9e65f****?_sugar_time=1612500688339&_sugar_signature=xM%2FNQv%2F5Je7o4j2046I0Gi%2BDmQegGn%2FEHXU%2BNskcEg****&sugar_sign_token=abcde"
6 // 传authType(1,2,3时)就表示大屏开启分享,这时返回的url就变成对应的分享链接,token方式是携带签名的shareUrl
7 },
8 patch: true
9}
返回错误 JSON 示例
Javascript
1{
2 msg: '错误详情',
3 status:499
4}