嵌出加密链接使用流程--智能数据洞察 DataWind-火山引擎

文档中心

智能数据洞察 DataWind

可视化查询

嵌出加密链接使用流程

本产品的私有化部署版本支持将图表或仪表盘的嵌出链接加密成短链。用户可通过 OpenAPI 对加密链接进行增、删、改、查，以及应用等操作。下文将为您具体介绍前出加密使用流程。

前提条件

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

对加密链接进行增删改查

生成短链接

请求说明

请求方式：POST
请求说明：{{domain}}/aeolus/api/v3/open/embedUrl/shortUrl

请求参数

参数	类型	是否必填	示例值	描述
fullUrl	string	是	"https://xxx.com/#/dashboard/123?appId=456"	完整的图表或仪表盘链接地址，获取可查看图表嵌出
zone	array	是	["z1", "z2"]	允许访问的网段，不能为空，如没有可填空数组
descr	string	是	“description”	为生成的短链接添加描述信息

请求示例

{
    # 完整链接地址
    "fullUrl": “https://xxx.com/#/dashboard/123?appId=456”,
    # 允许访问的网段，不能为空或者空数组
    "zone": ["z1", "z2"],
    # 描述信息
    "descr": “description”
}

返回参数

参数	类型	示例值	描述
code	string	"aeolus/ok"	成功状态码为`aeolus/ok` 失败状态码包括 `aeolus/embed/domainAdminOnly`：仅系统管理员可访问 `aeolus/embed/embedUrlMustHasParam`：嵌出链接需包含xxx=xxx格式参数 `aeolus/embed/embedUrlOnlySupportDashboardOrReport`：仅支持仪表盘 / 图表嵌出 `aeolus/openapiClient/tokenExpired`：token 过期 `aeolus/parameter/absent`：缺少必要参数，如`fullUrl`
data	object	{"id":6,"shortUrl":"pgJJ96KV9N91NtosFd5AXViWr1CKf4d4"}	仅成功时存在，包含： `id`：短链接唯一 ID（如 6） `shortUrl`：生成的短链接字符串
msg	string	"成功"	成功时显示 "成功" 失败时显示对应错误描述
extra_msg	object	{"params":"fullUrl"}	仅失败时存在，不同错误类型包含不同细节：缺少参数时`params`标注缺失字段（如`fullUrl`）其他错误类型此参数为空对象`{}`
queryHistoryId	int	0	查询历史ID，用于标识查询历史

返回示例

# 请求成功
{
    "code": "aeolus/ok",
    "data": {
        # 短链接唯一id
        "id": 6,
        # 短链接
        "shortUrl": "pgJJ96KV9N91NtosFd5AXViWr1CKf4d4"
    },
    "msg": "成功"
}
# 请求失败（当code不为"aeolus/ok"，请求就认为失败）
{
    "code": "aeolus/embed/domainAdminOnly",
    "extra_msg": {},
    "msg": "只有系统管理员才能访问",
    "queryHistoryId": 0
}
{
    "code": "aeolus/embed/embedUrlMustHasParam",
    "extra_msg": {},
    "msg": "嵌出链接需要包含xxx=xxx形式的配置参数",
    "queryHistoryId": 0
}
{
    "code": "aeolus/embed/embedUrlOnlySupportDashboardOrReport",
    "extra_msg": {},
    "msg": "嵌出链接只支持仪表盘或仪表盘中的图表",
    "queryHistoryId": 0
}
{
    "code": "aeolus/openapiClient/tokenExpired",
    "extra_msg": {},
    "msg": "token已过期",
    "queryHistoryId": 0
}
{
    "code": "aeolus/parameter/absent",
    "extra_msg": {
        "params": "fullUrl"
    },
    "msg": "缺少必要参数",
    "queryHistoryId": 0
}

修改短链接配置

请求说明

请求方式：PATCH
请求说明：{{domain}} /aeolus/api/v3/open/embedUrl/shortUrl

请求参数

参数	类型	是否必填	示例值	描述
id	int	否注意 id和shorturl至少传一个，如果两个都传，需要保证能匹配上，否则无法更新	1	短链接唯一id，获取方式见下文获取所有短链接
shortUrl	string	否	“DPnPSuSPYwnf5tLqGoO19HM48UAuri4h”	短链接，获取方式见下文获取所有短链接
fullUrl	string	是	“https://xxx.com/#/dashboard/123?appId=456”	完整的图表或仪表盘链接地址，获取可查看图表嵌出
zone	array	是	["z1", "z2"]	允许访问的网段，不能为空，如没有可填空数组
descr	string	是	“description”	为生成的短链接添加描述信息

请求示例

{
    # 短链接唯一id
    "id": 1,
    # 短链接
    "shortUrl": "DPnPSuSPYwnf5tLqGoO19HM48UAuri4h",
    # 以上参数至少有一个，如果两个都传，需要保证能匹配上，否则无法更新
    
    # 完整url
    "fullUrl": "https://xxx.com/#/dashboard/123?appId=789",
    # 允许访问的网段
    "zone": ["z3"],
    # 描述信息
    "descr": "新的描述"
}

返回参数

参数	类型	示例值	描述
code	string	"aeolus/ok"	成功状态码为`aeolus/ok` 失败状态码包括： `aeolus/embed/notFound`：短链接不存在或已删除 `aeolus/parameter/absent`：缺少必要参数，如`id` `aeolus/openapiClient/tokenExpired`：token 过期 `aeolus/embed/embedUrlMustHasParam`：需包含xxx=xxx格式参数 `aeolus/embed/embedUrlOnlySupportDashboardOrReport`：仅支持仪表盘 / 图表嵌出 `aeolus/embed/domainAdminOnly`：仅系统管理员可访问
data	object	{"id":6,"shortUrl":"pgJJ96KV9N91NtosFd5AXViWr1CKf4d4"}	成功时返回空对象{}
msg	string	"成功"	成功时显示 "成功" 失败时显示对应错误描述
extra_msg	object	{"params":"id"}	仅失败时存在，不同错误类型包含不同细节：缺少参数时`params`标注缺失字段（如`id`）其他错误类型此参数为空对象{}
queryHistoryId	int	0	查询历史ID，用于标识查询历史

返回示例

# 请求成功
{
    "code": "aeolus/ok",
    "data": {},
    "msg": "成功"
}
# 请求失败，当code不为"aeolus/ok"，请求就认为失败
{
    "code": "aeolus/embed/notFound",
    "extra_msg": {},
    "msg": "短连接不存在或已被删除",
    "queryHistoryId": 0
}
{
    "code": "aeolus/parameter/absent",
    "extra_msg": {
        "params": "id"
    },
    "msg": "缺少必要参数",
    "queryHistoryId": 0
}
{
    "code": "aeolus/openapiClient/tokenExpired",
    "extra_msg": {},
    "msg": "token已过期",
    "queryHistoryId": 0
}
{
    "code": "aeolus/embed/embedUrlMustHasParam",
    "extra_msg": {},
    "msg": "嵌出链接需要包含xxx=xxx形式的配置参数",
    "queryHistoryId": 0
}
{
    "code": "aeolus/embed/embedUrlOnlySupportDashboardOrReport",
    "extra_msg": {},
    "msg": "嵌出链接只支持仪表盘或仪表盘中的图表",
    "queryHistoryId": 0
}
{
    "code": "aeolus/embed/domainAdminOnly",
    "extra_msg": {},
    "msg": "只有系统管理员才能访问",
    "queryHistoryId": 0
}

失效短连接

请求说明

请求方式：PATCH
请求说明：{{domain}} /aeolus/api/v3/open/embedUrl/disableShortUrl

请求参数

参数	类型	是否必填	示例值	描述
id	int	否注意 id和shorturl至少传一个，如果两个都传，需要保证能匹配上，否则无法更新	1	短链接唯一id，获取方式见下文获取所有短链接
shortUrl	string	否	“DPnPSuSPYwnf5tLqGoO19HM48UAuri4h”	短链接，获取方式见下文获取所有短链接

请求示例

{
    # 短链接唯一id
    "id": 1,
    # 短链接
    "shortUrl": "DPnPSuSPYwnf5tLqGoO19HM48UAuri4h",
    # 以上参数至少有一个，如果两个都传，需要保证能匹配上，否则无法更新
}

返回参数

参数	类型	示例值	描述
code	string	"aeolus/ok"	成功状态码为`aeolus/ok` 失败状态码包括： `aeolus/embed/domainAdminOnly`：仅系统管理员可访问 `aeolus/openapiClient/tokenExpired`：token 过期 `aeolus/embed/notFound`：短链接不存在或已删除
data	object	{}	成功时返回空对象{}
msg	string	"成功"	成功时显示 "成功" 失败时显示对应错误描述
extra_msg	object	{}	仅失败时存在，不同错误类型包含不同细节：缺少参数时`params`标注缺失字段（如`id`）其他错误类型此参数为空对象{}
queryHistoryId	int	0	查询历史ID，用于标识查询历史

返回示例

# 请求成功
{
    "code": "aeolus/ok",
    "data": {},
    "msg": "成功"
}
# 请求失败，当code不为"aeolus/ok"，请求就认为失败
{
    "code": "aeolus/embed/domainAdminOnly",
    "extra_msg": {},
    "msg": "只有系统管理员才能访问",
    "queryHistoryId": 0
}
{
    "code": "aeolus/openapiClient/tokenExpired",
    "extra_msg": {},
    "msg": "token已过期",
    "queryHistoryId": 0
}
{
    "code": "aeolus/embed/notFound",
    "extra_msg": {},
    "msg": "短连接不存在或已被删除",
    "queryHistoryId": 0
}

生效短连接

请求说明

请求方式：PATCH
请求说明：{{domain}} /aeolus/api/v3/open/embedUrl/enableShortUrl

请求参数

名称	类型	必选	示例值	描述
id	int	否注意 id和shorturl至少传一个，如果两个都传，需要保证能匹配上，否则无法更新	1	短链接唯一id，获取方式见下文获取所有短链接
shortUrl	string	否	“DPnPSuSPYwnf5tLqGoO19HM48UAuri4h”	短链接，获取方式见下文获取所有短链接

请求示例

{
    # 短链接唯一id
    "id": 1,
    # 短链接
    "shortUrl": "DPnPSuSPYwnf5tLqGoO19HM48UAuri4h",
    # 以上参数至少有一个，如果两个都传，需要保证能匹配上，否则无法更新
}

返回参数

参数	类型	示例值	描述
code	string	"aeolus/ok"	成功状态码为`aeolus/ok` 失败状态码包括： `aeolus/embed/domainAdminOnly`：仅系统管理员可访问 `aeolus/openapiClient/tokenExpired`：token 过期 `aeolus/embed/notFound`：短链接不存在或已删除
data	object	{}	成功时返回空对象{}
msg	string	"成功"	成功时显示 "成功" 失败时显示对应错误描述
extra_msg	object	{}	仅失败时存在，不同错误类型包含不同细节：缺少参数时`params`标注缺失字段（如`id`）其他错误类型此参数为空对象{}
queryHistoryId	int	0	查询历史ID，用于标识查询历史

返回示例

# 请求成功
{
    "code": "aeolus/ok",
    "data": {},
    "msg": "成功"
}
# 请求失败（当code不为"aeolus/ok"，请求就认为失败）
{
    "code": "aeolus/embed/domainAdminOnly",
    "extra_msg": {},
    "msg": "只有系统管理员才能访问",
    "queryHistoryId": 0
}
{
    "code": "aeolus/openapiClient/tokenExpired",
    "extra_msg": {},
    "msg": "token已过期",
    "queryHistoryId": 0
}
{
    "code": "aeolus/embed/notFound",
    "extra_msg": {},
    "msg": "短连接不存在或已被删除",
    "queryHistoryId": 0
}

删除短连接

请求说明

请求方式：DELETE
请求说明：{{domain}} /aeolus/api/v3/open/embedUrl/shortUrl

请求参数

名称	类型	必选	示例值	描述
id	int	否注意 id和shorturl至少传一个，如果两个都传，需要保证能匹配上，否则无法更新	1	短链接唯一id，获取方式见下文获取所有短链接
shortUrl	string	否	“DPnPSuSPYwnf5tLqGoO19HM48UAuri4h”	短链接，获取方式见下文获取所有短链接

请求示例

{
    # 短链接唯一id
    "id": 1,
    # 短链接
    "shortUrl": "DPnPSuSPYwnf5tLqGoO19HM48UAuri4h",
    # 以上参数至少有一个，如果两个都传，需要保证能匹配上，否则无法更新
}

返回参数

参数	类型	示例值	描述
code	string	"aeolus/ok"	成功状态码为`aeolus/ok` 失败状态码包括： `aeolus/embed/domainAdminOnly`：仅系统管理员可访问 `aeolus/openapiClient/tokenExpired`：token 过期 `aeolus/embed/notFound`：短链接不存在或已删除
data	object	{}	成功时返回空对象{}
msg	string	"成功"	成功时显示 "成功" 失败时显示对应错误描述
extra_msg	object	{}	仅失败时存在，不同错误类型包含不同细节：缺少参数时`params`标注缺失字段（如`id`）其他错误类型此参数为空对象{}
queryHistoryId	int	0	查询历史ID，用于标识查询历史

返回示例

# 请求成功
{
    "code": "aeolus/ok",
    "data": {},
    "msg": "成功"
}
# 请求失败（当code不为"aeolus/ok"，请求就认为失败）
{
    "code": "aeolus/embed/domainAdminOnly",
    "extra_msg": {},
    "msg": "只有系统管理员才能访问",
    "queryHistoryId": 0
}
{
    "code": "aeolus/openapiClient/tokenExpired",
    "extra_msg": {},
    "msg": "token已过期",
    "queryHistoryId": 0
}
{
    "code": "aeolus/embed/notFound",
    "extra_msg": {},
    "msg": "短连接不存在或已被删除",
    "queryHistoryId": 0
}

获取所有短链接

请求说明

请求方式：GET
请求说明：{{domain}} /aeolus/api/v3/open/embedUrl/shortUrlList

返回参数

参数	类型	示例值	描述
code	string	"aeolus/ok"	成功状态码为`aeolus/ok`；失败状态码如`aeolus/embed/domainAdminOnly`（仅系统管理员可访问）
data	array	[{},{}....]	成功时返回短链接列表，每个对象包含： `ctime`：创建时间（如 "2023-07-21 16:38:00"） `descr`：描述信息（如 "description"） `fullUrl`：完整链接（含参数的长 URL） `id`：唯一 ID（如 3） `mtime`：最近修改时间 `shortUrl`：短链接字符串 `status`：状态（0 = 启用，1 = 失效） `zone`：生效网段列表（如 ["z1", "z2"]）
msg	string	"成功"	成功时显示 "成功" 失败时显示对应错误描述
extra_msg	object	{}	仅失败时存在，不同错误类型包含不同细节：缺少参数时`params`标注缺失字段（如`id`）其他错误类型此参数为空对象{}
queryHistoryId	int	0	查询历史ID，用于标识查询历史

返回示例

# 请求成功
{
    "code": "aeolus/ok",
    "data": [
        {
            # 创建时间
            "ctime": "2023-07-21 16:38:00",
            # 描述
            "descr": "description",
            # 完整链接
            "fullUrl": "https://xxx.com/#/external/dashboard/123?inline=true&appId=1&sheetId=2&feature=%7B%22dashboard%22%3A%7B%22showTitle%22%3Afalse%2C%22showOwner%22%3Afalse%2C%22showActions%22%3Afalse%2C%22sheetType%22%3A%22all%22%2C%22sheetList%22%3A%5B%5D%2C%22showHeader%22%3Afalse%2C%22showFavor%22%3Afalse%2C%22actions%22%3A%5B%5D%2C%22report%22%3A%7B%22showTitle%22%3Afalse%2C%22showTips%22%3Afalse%2C%22showToolbar%22%3Afalse%2C%22showHeader%22%3Afalse%7D%2C%22sheet%22%3A%7B%7D%7D%7D",
            # 唯一id
            "id": 3,
            # 最近一次修改时间
            "mtime": "2023-07-21 16:38:12",
            # 短链接
            "shortUrl": "TsouUsnzx0iOCxacDxpldJ6OfshLKPZf",
            # 链接状态，0：启用，1：失效
            "status": 0,
            # 生效网段
            "zone": ["z1"， "z2"]
        },
        {
            "ctime": "2023-07-21 18:06:32",
            "descr": "22222",
            "fullUrl": "https://xxx.com/#/external/dashboard/123/456?inline=true&appId=1&sheetId=2&feature=%7B%22dashboard%22%3A%7B%22report%22%3A%7B%22showTitle%22%3Afalse%2C%22showTips%22%3Afalse%2C%22showToolbar%22%3Afalse%2C%22showHeader%22%3Afalse%7D%7D%7D",,
            "id": 5,
            "mtime": "2023-07-21 18:47:21",
            "shortUrl": "DPnPSuSPYwnf5tLqGoO19HM48UAuri4h",
            "status": 1,
            "zone": ["z3"]
        }
    ],
    "msg": "成功"
}
# 请求失败（当code不为"aeolus/ok"，请求就认为失败）
{
    "code": "aeolus/embed/domainAdminOnly",
    "extra_msg": {},
    "msg": "只有系统管理员才能访问",
    "queryHistoryId": 0
}

对加密链接进行嵌出应用

注意

因为存在客户设置了多网络区的情况，不同网络区的域名存在差异，为了便于在多处场景使用，域名部分不参与短链生成。

具体操作步骤：

确定嵌出链接。
示例：
- 域名1：https://www.z1.com/#/dashboard/external/123?appId=456
- 域名2：https://www.z2.com/#/dashboard/external/123?appId=456
获取短链。利用 Open API 对完整嵌出链接生成加密短链。具体步骤见上文对加密链接进行增删改查。
示例：
- 域名1返回的短链：pgJJ96KV9N91NtosFd5AXViWr1CKf4d4
- 域名2返回的短链：DPnPSuSPYwnf5tLqGoO19HM48UAuri4h
拼接加密可访问的链接：“域名”+“bi#/share/” +“短链”。
示例：
- 域名1：https://www.z1.com/bi#/share/pgJJ96KV9N91NtosFd5AXViWr1CKf4d4
- 域名2：https://www.z2.com/bi#/share/DPnPSuSPYwnf5tLqGoO19HM48UAuri4h

加密前后示例：

加密前：https://www.z1.com/#/dashboard/external/123?appId=456
加密后：https://www.z1.com/bi#/share/pgJJ96KV9N91NtosFd5AXViWr1CKf4d4

最近更新时间：2025.09.18 12:01:33

这个页面对您有帮助吗？

有用

无用

智能数据洞察 DataWind

生成短链接 #

请求说明 #

请求参数 #

请求示例 #

返回参数 #

返回示例 #

修改短链接配置 #

请求说明 #

请求参数 #

请求示例 #

返回参数 #

返回示例 #

失效短连接 #

请求说明 #

请求参数 #

请求示例 #

返回参数 #

返回示例 #

生效短连接 #

请求说明 #

请求参数 #

请求示例 #

返回参数 #

返回示例 #

删除短连接 #

请求说明 #

请求参数 #

请求示例 #

返回参数 #

返回示例 #

获取所有短链接 #

请求说明 #

返回参数 #

返回示例 #

生成短链接

请求说明

请求参数

请求示例

返回参数

返回示例

修改短链接配置

请求说明

请求参数

请求示例

返回参数

返回示例

失效短连接

请求说明

请求参数

请求示例

返回参数

返回示例

生效短连接

请求说明

请求参数

请求示例

返回参数

返回示例

删除短连接

请求说明

请求参数

请求示例

返回参数

返回示例

获取所有短链接

请求说明

返回参数

返回示例