You need to enable JavaScript to run this app.
Intelligent Data Insight

Intelligent Data Insight

  • Documentation
    • Intelligent Data InsightDataWind User GuideOpen and IntegrationOpenAPIVisual QueryEncrypted Embedded Link Usage Process
Copy page
Download PDF
Visual Query
Encrypted Embedded Link Usage Process
Copy page
Download PDF
Encrypted Embedded Link Usage Process

The privatized deployment version of this product supports encrypting embedded links of charts or dashboards into short links. Users can use OpenAPI to add, delete, update, query, and apply encrypted links. The following will provide a detailed introduction to the usage process for encrypted embedding.

Prerequisites

Before using the interfaces described in this document, please first understand the invocation method and complete the Token application step. For details, see Invocation Method.

Add, Delete, Update, and Query Encrypted Links

Request description

  • Request method: POST
  • Request description: {{domain}}/aeolus/api/v3/open/embedUrl/shortUrl

Request parameters

Parameter

Type

Required

Example value

Description

fullUrl

string

Yes

"https://xxx.com/#/dashboard/123?appId=456"

The complete chart or dashboard link address. For how to obtain, see Chart Embedding

zone

array

Yes

["z1", "z2"]

The allowed network segments for access. Cannot be empty. If none, use an empty array.

descr

string

Yes

“description”

Add a description for the generated short link

Request example 

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

Response parameters

Parameter

Type

Sample value

Description

code

string

"aeolus/ok"

  • The success status code is aeolus/ok
  • The failure status codes include
    • aeolus/embed/domainAdminOnly: Only system administrators can access
    • aeolus/embed/embedUrlMustHasParam: The embedded link must include a parameter in the format xxx=xxx
    • aeolus/embed/embedUrlOnlySupportDashboardOrReport: Only dashboard or chart embedding is supported
    • aeolus/openapiClient/tokenExpired: Token expired
    • aeolus/parameter/absent: Missing required parameter, such as fullUrl

data

object

{"id":6,"shortUrl":"pgJJ96KV9N91NtosFd5AXViWr1CKf4d4"}

Present only on success, includes:

  • id: Unique ID of the short link (for example, 6)
  • shortUrl: The generated short link string

msg

string

"Success"

  • Displays "Success" on success
  • Displays the corresponding error description on failure

extra_msg

object

{"params":"fullUrl"}

Present only on failure; different error types include different details:

  • When a parameter is missing, params indicates the missing field (for example, fullUrl)
  • For other error types, this parameter is an empty object {}

queryHistoryId

int

0

Query history ID, used to identify the query history

Response example 

# 请求成功
{
    "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
}

Request description

  • Request method: PATCH
  • Request description: {{domain}} /aeolus/api/v3/open/embedUrl/shortUrl

Request parameters

Parameter

Type

Required

Sample value

Description

id

int

No

warning

At least one of id or shorturl must be provided. If both are provided, they must match; otherwise, the update cannot proceed.

1

Unique ID of the short link. For how to obtain, see Get all short links below

shortUrl

string

No

“DPnPSuSPYwnf5tLqGoO19HM48UAuri4h”

Short link. For how to obtain, see Get all short links below

fullUrl

string

Yes

“https://xxx.com/#/dashboard/123?appId=456”

The complete chart or dashboard link address. For how to obtain, see Chart Embedding

zone

array

Yes

["z1", "z2"]

Permitted network segments for access. Cannot be empty. If none, provide an empty array

descr

string

Yes

“description”

Add a description for the generated short link

Request example 

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

Response parameters

Parameter

Type

Sample value

Description

code

string

"aeolus/ok"

  • The success status code is aeolus/ok
  • The failure status codes include:
    • aeolus/embed/notFound: The short link does not exist or has been deleted
    • aeolus/parameter/absent: Missing required parameter, such as id
    • aeolus/openapiClient/tokenExpired: Token expired
    • aeolus/embed/embedUrlMustHasParam: Must include a parameter in the format xxx=xxx
    • aeolus/embed/embedUrlOnlySupportDashboardOrReport: Only dashboard or chart embedding is supported
    • aeolus/embed/domainAdminOnly: Only system administrators can access

data

object

{"id":6,"shortUrl":"pgJJ96KV9N91NtosFd5AXViWr1CKf4d4"}

Returns an empty object {} on success

msg

string

"Success"

  • Displays "Success" on success
  • Displays the corresponding error description on failure

extra_msg

object

{"params":"id"}

Present only on failure; different error types include different details:

  • When a parameter is missing, params indicates the missing field (for example, id)
  • For other error types, this parameter is an empty object {}

queryHistoryId

int

0

Query history ID, used to identify the query history

Response example 

# 请求成功
{
    "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
}

Request description

  • Request method: PATCH
  • Request description: {{domain}} /aeolus/api/v3/open/embedUrl/disableShortUrl

Request parameters

Parameter

Type

Required

Sample value

Description

id

int

No

warning

At least one of id or shorturl must be provided. If both are provided, they must match; otherwise, the update cannot proceed.

1

Unique ID of the short link. For how to obtain, see Get all short links below

shortUrl

string

No

“DPnPSuSPYwnf5tLqGoO19HM48UAuri4h”

Short link. For how to obtain, see Get all short links below

Request example 

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

Response parameters

Parameter

Type

Sample value

Description

code

string

"aeolus/ok"

  • The success status code is aeolus/ok
  • Failure status codes include:
    • aeolus/embed/domainAdminOnly: Accessible only to system administrators
    • aeolus/openapiClient/tokenExpired: Token expired
    • aeolus/embed/notFound: The short link does not exist or has been deleted

data

object

{}

Returns an empty object {} on success

msg

string

"Success"

  • Displays "Success" on success
  • Displays the corresponding error description on failure

extra_msg

object

{}

Present only on failure; different error types contain different details:

  • When parameters are missing, params indicates the missing fields (such as id)
  • For other error types, this parameter is an empty object {}

queryHistoryId

int

0

Query history ID, used to identify the query history

Response example 

# 请求成功
{
    "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
}

Request description

  • Request method: PATCH
  • Request description: {{domain}} /aeolus/api/v3/open/embedUrl/enableShortUrl

Request parameters

Name

Type

Required

Example value

Description

id

int

No

warning

At least one of id or shorturl must be provided. If both are provided, they must match; otherwise, the update cannot proceed.

1

Unique short link ID. For how to obtain, see Get all short links below

shortUrl

string

No

“DPnPSuSPYwnf5tLqGoO19HM48UAuri4h”

Short link. For how to obtain, see Get all short links below

Request example 

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

Response parameters

Parameter

Type

Example value

Description

code

string

"aeolus/ok"

  • The success status code is aeolus/ok
  • Failure status codes include:
    • aeolus/embed/domainAdminOnly: Accessible only to system administrators
    • aeolus/openapiClient/tokenExpired: Token expired
    • aeolus/embed/notFound: The short link does not exist or has been deleted

data

object

{}

Returns an empty object {} on success

msg

string

"Success"

  • Displays "Success" on success
  • Displays the corresponding error description on failure

extra_msg

object

{}

Present only on failure; different error types contain different details:

  • When parameters are missing, params indicates the missing fields (such as id)
  • For other error types, this parameter is an empty object {}

queryHistoryId

int

0

Query history ID, used to identify the query history

Response example 

# 请求成功
{
    "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
}

Request description

  • Request method: DELETE
  • Request description: {{domain}} /aeolus/api/v3/open/embedUrl/shortUrl

Request parameters

Name

Type

Required

Example value

Description

id

int

No

warning

At least one of id or shorturl must be provided. If both are provided, they must match; otherwise, the update cannot proceed.

1

Unique short link ID. For how to obtain, see Get all short links below

shortUrl

string

No

“DPnPSuSPYwnf5tLqGoO19HM48UAuri4h”

Short link. For how to obtain, see Get all short links below

Request example 

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

Response parameters

Parameter

Type

Example value

Description

code

string

"aeolus/ok"

  • The success status code is aeolus/ok
  • Failure status codes include:
    • aeolus/embed/domainAdminOnly: Accessible only to system administrators
    • aeolus/openapiClient/tokenExpired: Token expired
    • aeolus/embed/notFound: The short link does not exist or has been deleted

data

object

{}

Returns an empty object {} on success

msg

string

"Success"

  • Displays "Success" on success
  • Displays the corresponding error description on failure

extra_msg

object

{}

Present only on failure; different error types contain different details:

  • When parameters are missing, params indicates the missing fields (such as id)
  • For other error types, this parameter is an empty object {}

queryHistoryId

int

0

Query history ID, used to identify the query history

Response example 

# 请求成功
{
    "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
}

Request description

  • Request method: GET
  • Request description: {{domain}} /aeolus/api/v3/open/embedUrl/shortUrlList

Response parameters

Parameter

Type

Example value

Description

code

string

"aeolus/ok"

The success status code is aeolus/ok; failure status codes include aeolus/embed/domainAdminOnly (accessible only to system administrators)

data

array

[{},{}....]

On success, returns a list of short links. Each object contains:

  • ctime: Creation time (for example, "2023-07-21 16:38:00")
  • descr: Description (for example, "description")
  • fullUrl: Full URL (long URL with parameters)
  • id: Unique ID (for example, 3)
  • mtime: Last modified time
  • shortUrl: Short link string
  • status: Status (0 = enabled, 1 = disabled)
  • zone: List of valid network segments (for example, ["z1", "z2"])

msg

string

"Success"

  • Displays "Success" on success
  • Displays the corresponding error description on failure

extra_msg

object

{}

Present only on failure. Different error types contain different details:

  • When parameters are missing, params indicates the missing fields (for example, id)
  • For other error types, this parameter is an empty object {}

queryHistoryId

int

0

Query history ID, used to identify the query history

Response example 

# 请求成功
{
    "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
}

Apply Encrypted Links for Embedding

warning

Because some customers have multiple network zones and domain names differ between zones, the domain name part is not included in short link generation to facilitate use in multiple scenarios.

Specific operation steps:

  1. Identify the embedded link.
    Example:
    • Domain 1: https://www.z1.com/#/dashboard/external/123?appId=456
    • Domain 2: https://www.z2.com/#/dashboard/external/123?appId=456
  2. Obtain the short link. Use the Open API to generate an encrypted short link for the complete embedded link. For detailed steps, see Add, delete, update, and query encrypted links above.
    Example:
    • Short link returned by Domain 1: pgJJ96KV9N91NtosFd5AXViWr1CKf4d4
    • Short link returned by Domain 2: DPnPSuSPYwnf5tLqGoO19HM48UAuri4h
  3. Concatenate the encrypted accessible link: "Domain" + "bi#/share/" + "short link".
    Example:
    • Domain 1: https://www.z1.com/bi#/share/pgJJ96KV9N91NtosFd5AXViWr1CKf4d4
    • Domain 2: https://www.z2.com/bi#/share/DPnPSuSPYwnf5tLqGoO19HM48UAuri4h

Examples before and after encryption:

  • Before encryption: https://www.z1.com/#/dashboard/external/123?appId=456
  • After encryption: https://www.z1.com/bi#/share/pgJJ96KV9N91NtosFd5AXViWr1CKf4d4
Last updated: 2026.07.06 17:09:13