可视化-数据订阅 Open API--智能数据洞察（私有化）-火山引擎

文档中心

智能数据洞察（私有化）

可视化查询

可视化-数据订阅 Open API

前提条件

在您使用本文所述的接口前，请先了解调用方式，详情可阅读调用方式。

获取订阅列表

用于获取有权限的仪表盘订阅配置列表。项目管理员、系统管理员能获取所有订阅；仪表盘管理员能获取仪表盘的所有订阅；其他权限能获取创建人、接收人、权限依据人为本人的订阅。

请求说明

请求方式：GET
请求说明：{{domain}}/aeolus/api/open/v2/subscription/subscriptions

请求参数

参数	类型	是否必填	示例值	描述
appId	int	是	1	项目ID，获取方式见资源 ID 获取方式
dashboardId	int	否	1	仪表盘ID，获取方式见资源 ID 获取方式
subscriber	string	否	"xiaoming"	接收人邮箱前缀，即邮箱地址中`@`符号前的部分。若邮箱为 `xiaoming@example.com`，则 `subscriber` 为 `xiaoming`。
pageSize	int	否	20	每页数据条数，默认值：20
pageNumber	int	否	1	页码，默认值：1

返回参数

参数	类型	示例值	描述
data.pageNumber	int	20	当前页码
data.pageSize	int	1	每页显示的记录数
data.results	array		结果列表，包含具体的订阅信息
data.results.id	int	1000	订阅的唯一标识 ID
data.results.owner	string	“xiaoming”	订阅的所有者
data.results.status	int	0	订阅的状态，0：正常，1：已删除，2：暂停
data.results.title	object		订阅标题相关信息
data.results.title.offset	int	0	日期偏移值，withDate 为 true 时有效
data.results.title.title	string	“datawind 订阅”	标题名称
data.results.title.withDate	boolean	true	标题是否带日期
data.results.content	object		推送内容相关设置
data.results.content.dashboardContentFormat	string	img	仪表盘推送形式，img：图片、pdf：pdf文件
data.results.content.dashboardContentVisible	boolean	true	是否显示仪表盘内容
data.results.content.dashboardLinkVisible	boolean	true	是否显示仪表盘链接
data.results.description	string	“description”	订阅的描述信息
data.results.dashboard	object		关联的仪表盘信息
data.results.dashboard.id	int	144250	仪表盘ID，仪表盘的唯一标识
data.results.dashboard.name	string	“datawind 仪表盘”	仪表盘名称
data.results.noticeType	int	0	创建/修改通知方式，0：推送给接收人、1：推送给创建者
data.results.pushTime	object		推送时间相关设置
data.results.pushTime.frequency	int	3	推送频率，0：天级、3：周级、5：月级
data.results.pushTime.offset	int	2	数据集同步日期偏移，如 1 表示 T-1 的数据分区，仅 untilDataReady 为 true 时有效
data.results.pushTime.time	array	["10:00"]	推送时间列表，格式：HH:MM，如：10:00 表示上午 10 点整
data.results.pushTime.timezone	string	“UTC-08:00”	时区，格式如：UTC-08:00
data.results.pushTime.untilDataReady	boolean	true	是否等待数据集同步完成才推送
data.results.pushTime.weekdays	array	[1,2]	推送星期列表，表示每周的哪些天推送，[0,6]（周一～周日）
data.results.pushType	string	lark	推送方式，lark（飞书）、lark_group（飞书群）、email（邮件）、email_group（邮件组）、dingtalk（钉钉）、dingtalk_group（钉钉群）、webcom（企业微信）、webex（webex）
data.results.subscribers	array		接收人列表
data.results.subscribers.agent	string	“agent”	权限依据人邮箱前缀，即邮箱中`@`符号前的部分。若邮箱为 `agent@example.com`，则 `subscriber` 为 `agent`。权限依据人即推送内容依据谁的权限。比如当仪表盘中存在图表对应数据集设定了行权限时，选择不同的权限依据人，可能会产生并推送不同的数据。
data.results.subscribers.subscriber	string	”xiaoming“	接收人邮箱前缀，即邮箱中`@`符号前的部分。若邮箱为 `xiaoming@example.com`，则 `subscriber` 为 `xiaoming`。
data.results.urls	array		相关 URL 列表
data.results.urls.title	string	“仪表盘 sheet-01”	URL 的标题
data.results.urls.url	string	“https://www.example.com“	具体的 URL 地址
data.results.remark	object		备注相关信息
data.results.remark.content	string	“订阅说明”	备注内容
data.results.remark.manageLinkVisible	boolean	true	推送信息是否显示订阅管理入口地址
data.results.remark.screenshotTimeVisible	boolean	true	推送消息是否显示截图时间
data.results.config	object		订阅的配置信息
data.results.config.autoRetry	boolean	false	是否自动重试
data.results.config.autoSyncSheets	boolean	false	订阅范围是否自动同步仪表盘配置。
data.results.config.language	string	auto	语言，auto（自动）、zh_CN（中文）、en_US（英文）
data.results.config.manageUrl	string	““https://www.example.com“”	订阅管理链接
data.results.config.noPushIfAbnormal	boolean	false	图表异常是否不推送
data.total	int	1	结果总数量

返回示例

{
    "code":"aeolus/ok",
    "data":{
        "pageNumber":20,
        "pageSize":1,
        "results":[
            {
                "id":1000,
                "owner":"***********",
                "status":0,
                "title":{
                    "offset":1,
                    "title":"datawind订阅",
                    "withDate":true
                },
                "content":{
                    "dashboardContentFormat":"img",
                    "dashboardContentVisible":true,
                    "dashboardLinkVisible":false
                },
                "description":"description",
                "dashboard":{
                    "id":144250,
                    "name":"datawind仪表盘"
                },
                "noticeType":0,
                "pushTime":{
                    "frequency":3,
                    "offset":2,
                    "time":[
                        "10:00"
                    ],
                    "timezone":"UTC+08:00",
                    "untilDataReady":true,
                    "weekdays":[
                        1,
                        2
                    ]
                },
                "pushType":"lark",
                "subscribers":[
                    {
                        "agent":"***********",
                        "subscriber":"***********"
                    }
                ],
                "urls":[
                    {
                        "title":"仪表盘sheet-01",
                        "url":"仪表盘URL"
                    }
                ],
                "remark":{
                    "content":"订阅说明",
                    "manageLinkVisible":true,
                    "screenshotTimeVisible":true
                },
                "config":{
                    "autoRetry":false,
                    "autoSyncSheets":false,
                    "language":"auto",
                    "manageUrl":"订阅管理URL",
                    "noPushIfAbnormal":false
                }
            }
        ],
        "total":1
    },
    "msg":"成功"
}

创建订阅

用于创建仪表盘订阅配置。

注意

只能创建有对应权限的仪表盘的订阅。

请求说明

请求方式：POST
请求说明：{{domain}} /aeolus/api/open/v2/subscription/subscriptions

请求参数

参数	类型	是否必填	示例值	描述
config	object	否		订阅的配置信息
config.autoRetry	boolean	否	true	失败是否重试，默认值为 false
config.autoSyncSheets	boolean	否	false	订阅范围是否自动同步仪表盘配置。 urls 为空时默认值为 true，否则默认值为 false。 autoSyncSheets 为 true 时，忽略 urls 参数。
config.language	string	否	"auto"	语言，可选值：auto（自动）、zh_CN（中文）、en_US（英文）
config.manageUrl	string	否	"“https://www.example.com“"	订阅管理链接，不传则设置为 DataWind 项目中心订阅管理页面地址
config.noPushIfAbnormal	boolean	否	true	图表异常是否不推送，默认值为 false
content	object	是		推送内容配置
content.dashboardContentFormat	string	否	"img"	仪表盘推送形式，img：图片、pdf：pdf 文件，默认值为 img
content.dashboardContentVisible	boolean	否	true	是否显示仪表盘内容，默认是为 true
content.dashboardLinkVisible	boolean	否	true	是否显示仪表盘链接，默认值为 true
appId	int	是	1	项目ID，获取方式见资源 ID 获取方式
dashboardId	int	是	1	仪表盘ID，表示订阅的仪表盘ID，urls为空或者不传时有效，表示订阅仪表盘的所有sheet，获取方式见资源 ID 获取方式
pushTime	object	是		推送时间
pushTime.frequency	int	是	3	推送频率，0：天级、3：周级、5：月级
pushTime.offset	int	否	2	数据集同步日期偏移，如 1 表示 T-1 的数据分区，仅 untilDataReady 为 true 时有效，默认值为 1
pushTime.weekdays	array[int]	否	[1,2]	推送星期列表，表示每周的哪些天推送，推送频率为周级时有效且必填，可选值范围：[0,6]（周一～周日）
pushTime.days	array[int]	否		推送日期列表，推送频率为月级时有效且必填，可选值范围：[1,31]
pushTime.time	array[string]	是	["10:00"]	推送时间列表，格式：HH:MM，如：10:00 表示上午 10 点整
pushTime.timezone	string	是	"UTC-08:00"	时区，格式如：UTC-08:00
pushTime.untilDataReady	boolean	否	true	是否等待数据集同步完成才推送，默认值为 false
pushType	string	是	"lark"	推送方式，可选值：lark（飞书）、lark_group（飞书群）、email（邮件）、email_group（邮件组）、dingtalk（钉钉）、dingtalk_group（钉钉群）、webcom（企业微信）、webex（webex）
remark	object	否		备注信息
remark.content	string	否	"订阅说明"	备注内容
remark.manageLinkVisible	bool	否	true	推送消息是否显示订阅管理入口地址，默认值为 true
remark.screenshotTimeVisible	bool	否	true	推送消息是否显示截图时间，默认值为 true
subscribers	array[object]	是		接收人列表
subscribers.agent	string	是	“agent”	权限依据人邮箱前缀，即邮箱中`@`符号前的部分。若邮箱为 `agent@example.com`，则 `subscriber` 为 `agent`。权限依据人即推送内容依据谁的权限。比如当仪表盘中存在图表对应数据集设定了行权限时，选择不同的权限依据人，可能会产生并推送不同的数据。
subscribers.subscriber	string	是	”xiaoming“	接收人邮箱前缀，即邮箱中`@`符号前的部分。若邮箱为 `xiaoming@example.com`，则 `subscriber` 为 `xiaoming`。
title	object	是		标题信息
title.offset	int	否	0	日期偏移值，withDate 为 true 时有效，默认值为 0
title.title	string	是	"DataWind 订阅"	标题名称
title.withDate	bool	否	true	标题是否带日期，默认值为 false
urls	array[object]	是		订阅 sheet 列表
urls.url	string	是	"“https://www.example.com“"	订阅 sheet 地址，获取方式见获取订阅列表

请求示例

{
    "config": {
        "autoRetry": true,
        "autoSyncSheets": false,
        "language": "auto",
        "manageUrl": "订阅管理URL",
        "noPushIfAbnormal": true
    },
    "content": {
        "dashboardContentFormat": "img",
        "dashboardContentVisible": true,
        "dashboardLinkVisible": false
    },
    "appId": 555371,
    "dashboardId": *******,
    "description": "description",
    "noticeType": 0,
    "pushTime": {
        "frequency": 3,
        "offset": 2,
        "weekdays": [
            1,
            2
        ],
        "time": [
            "10:00"
        ],
        "timezone": "UTC-08:00",
        "untilDataReady": true
    },
    "pushType": "lark",
    "remark": {
        "content": "",
        "manageLinkVisible": true,
        "screenshotTimeVisible": true
    },
    "subscribers": [
        {
            "agent": "***********",
            "subscriber": "***********"
        }
    ],
    "title": {
        "offset": 1,
        "title": "DataWind订阅",
        "withDate": true
    },
    "urls": [
        {
            "url": "仪表盘链接URL"
        }
    ]
}

返回参数

参数	类型	示例值	描述
code	string	“aeolus/ok”	返回码，可参考错误码
data	object		数据内容
data.subscriptionId	int	1000	创建的订阅ID
msg	string	“成功”	提示信息

返回示例

{
    "code": "aeolus/ok",
    "data": {
        "subscriptionId": 1000
    },
    "msg": "成功"
}

更新订阅

用于修改已有的仪表盘订阅。

注意

只能修改有权限的订阅，项目管理员、系统管理员可以修改任意订阅，仪表盘管理员可修改对应仪表盘的订阅，订阅所有者可修改自己创建的订阅。

请求说明

请求方式：PATCH
请求说明：{{domain}}/aeolus/api/open/v2/subscription/subscriptions

请求参数

参数	类型	是否必填	示例值	描述
id	int	是	1000	订阅ID，获取方式见获取订阅列表
status	int	否	0	状态，0：正常，2：暂停
config	object	否		订阅的配置信息
config.autoRetry	boolean	否	true	失败是否重试，默认值为 false
config.autoSyncSheets	boolean	否	false	订阅范围是否自动同步仪表盘配置。 urls 为空时默认值为 true，否则默认值为 false。 autoSyncSheets 为 true 时，忽略 urls 参数。
config.language	string	否	"auto"	语言，可选值：auto（自动）、zh_CN（中文）、en_US（英文）
config.manageUrl	string	否	"“https://www.example.com“"	订阅管理链接，不传则设置为 DataWind 项目中心订阅管理页面地址
config.noPushIfAbnormal	boolean	否	true	图表异常是否不推送，默认值为 false
content	object	是		推送内容配置
content.dashboardContentFormat	string	否	"img"	仪表盘推送形式，img：图片、pdf：pdf 文件，默认值为 img
content.dashboardContentVisible	boolean	否	true	是否显示仪表盘内容，默认是为 true
content.dashboardLinkVisible	boolean	否	true	是否显示仪表盘链接，默认值为 true
appId	int	是	1	项目ID，获取方式见资源 ID 获取方式
dashboardId	int	是	1	仪表盘ID，表示订阅的仪表盘ID，urls为空或者不传时有效，表示订阅仪表盘的所有sheet，获取方式见资源 ID 获取方式
description	string	否	“description”	订阅说明
noticeType	int	否	1	创建/修改通知方式，0：推送给接收人、1：推送给创建者
pushTime	object	是		推送时间，不支持修改pushTime的单个字段
pushTime.frequency	int	是	3	推送频率，0：天级、3：周级、5：月级
pushTime.offset	int	否	2	数据集同步日期偏移，如 1 表示 T-1 的数据分区，仅 untilDataReady 为 true 时有效，默认值为 1
pushTime.weekdays	array[int]	否	[1,2]	推送星期列表，表示每周的哪些天推送，推送频率为周级时有效且必填，可选值范围：[0,6]（周一～周日）
pushTime.days	array[int]	否		推送日期列表，推送频率为月级时有效且必填，可选值范围：[1,31]
pushTime.time	array[string]	是	["10:00"]	推送时间列表，格式：HH:MM，如：10:00 表示上午 10 点整
pushTime.timezone	string	是	"UTC-08:00"	时区，格式如：UTC-08:00
pushTime.untilDataReady	boolean	否	true	是否等待数据集同步完成才推送，默认值为 false
pushType	string	是	"lark"	推送方式，可选值：lark（飞书）、lark_group（飞书群）、email（邮件）、email_group（邮件组）、dingtalk（钉钉）、dingtalk_group（钉钉群）、webcom（企业微信）、webex（webex）
remark	object	否		备注信息
remark.content	string	否	"订阅说明"	备注内容
remark.manageLinkVisible	bool	否	true	推送消息是否显示订阅管理入口地址，默认值为 true
remark.screenshotTimeVisible	bool	否	true	推送消息是否显示截图时间，默认值为 true
subscribers	array[object]	是		接收人列表
subscribers.agent	string	是	“agent”	权限依据人邮箱前缀，即邮箱中`@`符号前的部分。若邮箱为 `agent@example.com`，则 `subscriber` 为 `agent`。权限依据人即推送内容依据谁的权限。比如当仪表盘中存在图表对应数据集设定了行权限时，选择不同的权限依据人，可能会产生并推送不同的数据。
subscribers.subscriber	string	是	”xiaoming“	接收人邮箱前缀，即邮箱中`@`符号前的部分。若邮箱为 `xiaoming@example.com`，则 `subscriber` 为 `xiaoming`。
title	object	是		标题信息
title.offset	int	否	0	日期偏移值，withDate 为 true 时有效，默认值为 0
title.title	string	是	"DataWind 订阅"	标题名称
title.withDate	bool	否	true	标题是否带日期，默认值为 false
urls	array[object]	是		订阅 sheet 列表
urls.url	string	是	"“https://www.example.com“"	订阅 sheet 地址，获取方式见获取订阅列表

请求示例

{
    "id": 1000,
    "status": 0,
    "config": {
        "autoRetry": true,
        "autoSyncSheets": false,
        "language": "auto",
        "manageUrl": "订阅管理URL",
        "noPushIfAbnormal": true
    },
    "content": {
        "dashboardContentFormat": "img",
        "dashboardContentVisible": true,
        "dashboardLinkVisible": false
    },
    "appId":{appId},
    "dashboardId": ******,
    "description": "description",
    "noticeType": 0,
    "pushTime": {
        "frequency": 3,
        "offset": 2,
        "weekdays": [
            1,
            2
        ],
        "time": [
            "10:00"
        ],
        "timezone": "UTC-08:00",
        "untilDataReady": true
    },
    "pushType": "lark",
    "remark": {
        "content": "",
        "manageLinkVisible": true,
        "screenshotTimeVisible": true
    },
    "subscribers": [
        {
            "agent": "***********",
            "subscriber": "***********"
        }
    ],
    "title": {
        "offset": 1,
        "title": "DataWind订阅",
        "withDate": true
    },
    "urls": [
        {
            "url": "仪表盘URL"
        }
    ]
}

返回参数

参数	类型	示例值	描述
code	string	“aeolus/ok”	返回码，可参考错误码
data	object		数据内容
data.subscriptionId	int	1000	创建的订阅ID
msg	string	“成功”	提示信息

返回示例

{
    "code": "aeolus/ok",
    "data": {
        "subscriptionId": 1000
    },
    "msg": "成功"
}

删除订阅

用于批量删除有权限的仪表盘订阅。

注意

只能删除有权限的订阅，项目管理员、系统管理员可以删除任意订阅，仪表盘管理员可删除对应仪表盘的订阅，订阅所有者可删除自己创建的订阅。

请求说明

请求方式：DELETE
请求说明：{{domain}} /aeolus/api/open/v2/subscription/subscriptions

请求参数

参数	类型	是否必填	示例值	描述
appId	int	是	1	项目ID，获取方式见资源 ID 获取方式
subscriptions	array[int]	是	「1000, 1002」	需要删除的的订阅ID列表，获取方式见获取订阅列表

返回参数

名称	类型	示例值	描述
code	string	“aeolus/ok”	返回码，可参考错误码
data	object		数据内容
data.deletedSubscriptions	array[int]	「1000, 1002」	成功删除的订阅列表
data.totalCount	int	1	删除的总订阅数
msg	string	“成功”	提示信息

返回示例

{
    "code": "aeolus/ok",
    "data": {
        "deletedSubscriptions": [
            10827
        ],
        "totalCount": 1
    },
    "msg": "成功"
}

退订订阅

退订指定用户的订阅，同时支持根据仪表盘ID退订全部订阅以及根据订阅ID退订指定订阅。

注意

只能退订有修改删除权限的订阅。

请求说明

请求方式：DELETE
请求说明：{{domain}} /aeolus/api/open/v2/subscription/unsubscribe

请求参数

参数	类型	是否必填	示例值	描述
appId	int	是	1	项目ID，获取方式见资源 ID 获取方式
subscriptions	array[int]	是	「1000, 1002」	需退订的订阅ID列表，，获取方式见获取订阅列表
subscriber	string	是	”xiaoming“	接收人邮箱前缀，即邮箱中`@`符号前的部分。若邮箱为 `xiaoming@example.com`，则 `subscriber` 为 `xiaoming`。
dashboardId	int	否	1	需退订订阅的仪表盘ID，会退订此仪表盘的所有订阅，获取方式见资源 ID 获取方式

返回参数

参数	类型	示例	描述
code	string	“aeolus/ok”	返回码，可参考错误码
data	object		数据内容
totalCount	int	5	删除的订阅数
unsubscribedSubscriptions	array[int]	「1000, 1002」	成功退订的订阅列表
msg	string	“成功”	提示信息

返回示例

{
    "code": "aeolus/ok",
    "data": {
        "totalCount": 5,
        "unsubscribedSubscriptions": [
            10825
        ]
    },
    "msg": "成功"
}

错误码

错误码	错误信息	说明
aeolus/ok	成功	请求成功
aeolus/validation/validationFailed	接口参数校验失败，参数不符合检查规则	请求参数错误
aeolus/user/unauthorized	用户无权限	用户无相关资源权限（仪表盘、订阅）

最近更新时间：2025.07.09 16:09:07

这个页面对您有帮助吗？

有用

无用

智能数据洞察（私有化）

请求说明 #

请求参数 #

返回参数 #

返回示例 #

请求说明 #

请求参数 #

请求示例 #

返回参数 #

返回示例 #

请求说明 #

请求参数 #

请求示例 #

返回参数 #

返回示例 #

请求说明 #

请求参数 #

返回参数 #

返回示例 #

请求说明 #

请求参数 #

返回参数 #

返回示例 #

错误码 #

请求说明

请求参数

返回参数

返回示例

请求说明

请求参数

请求示例

返回参数

返回示例

请求说明

请求参数

请求示例

返回参数

返回示例

请求说明

请求参数

返回参数

返回示例

请求说明

请求参数

返回参数

返回示例

错误码