You need to enable JavaScript to run this app.
导航

设置控制台内嵌参数

最近更新时间2023.11.13 16:31:33

首次发布时间2022.11.25 21:31:15

日志服务提供控制台内嵌功能,即支持将查询分析等页面嵌入到外部系统的自建 Web 页面中。构建日志服务控制台内嵌的免密访问链接时,您可以通过指定 URL 参数的形式设置内嵌页面的显示效果。

页面 URL 格式

构建日志服务控制台内嵌的免密访问链接时,redirectURI 部分应指定为 encodeURL 转码后的日志服务控制台页面链接。链接格式如下:

https://console.volc-embed.com/tls/region:tls+${regionId}/project/${projectId}/search?UI参数1&UI参数2

其中:

  • regionId 为日志服务资源所在的地域 ID,您可以在服务地址中查看日志服务支持的所有Region ID。
  • projectId 为日志项目 ID,您可以在日志服务控制台中查看日志项目 ID。详细步骤请参考日志项目
  • 支持设置的 UI 参数列表请参考UI 参数

UI 参数

日志服务提供以下 UI 参数,您可以在页面链接中按需使用。

参数

参数类型

是否必选

示例

说明

hideLeftBar

Boolean

可选

true

是否隐藏火山引擎日志服务控制台的左侧导航栏。

  • true:隐藏。
  • false:(默认)不隐藏。

hideTitle

Boolean

可选

true

是否隐藏火山引擎日志服务控制台检索分析页面的页面标题栏。

  • true:隐藏。
  • false:(默认)不隐藏。

hideTopic

Boolean

可选

true

是否隐藏火山引擎日志服务控制台检索分析页面的 Topic 选择框。

  • true:隐藏。
  • false:(默认)不隐藏。

hideIndexBtn

Boolean

可选

true

是否隐藏火山引擎日志服务控制台检索分析页面的设置索引按钮。

  • true:隐藏。
  • false:(默认)不隐藏。

hideShareBtn

Boolean

可选

true

是否隐藏火山引擎日志服务控制台检索分析页面的分享图标。

  • true:隐藏。
  • false:(默认)不隐藏。

topicId

String

可选

c5c0a2a1-8431-4370-b98c-d20f5f7d****

日志主题 ID。您可以在日志服务控制台中查看日志主题 ID。详细步骤请参考日志主题

codebase64

String

可选

KiB8IHNlbGVjdCAq

默认的检索分析语句,应经过 Base64Url 编码。

time

String

可选

now-1m,now

要检索日志的时间范围。支持设置固定时间范围或自定义时间范围。

  • 自定义时间范围:格式为 ${startTime},${endTime},其中 startTimeendTime 的格式为 YYYY-MM-DD HH:mm:ss.SSS
  • 固定时间范围的配置请参考下表。

time 字段支持设置的固定时间范围格式如下:

time 枚举值

说明

now-1m,now

近 1 分钟。

now-5m,now

近 5 分钟。

now-15m,now

近 15 分钟。

now-30m,now

近 30 分钟。

now-1h,now

近 1 小时。

now-3h,now

近 3 小时。

now-6h,now

近 6 小时。

now-1d,now

近 1 天。

now-3d,now

近 3 天。

now-7d,now

近 7 天。

now-30d,now

近 30 天。

now-90d,now

近 90 天。

now/d,now/d

今天。

now/w,now/w

本周。

now/M,now/M

本月。

示例

以下示例表示第三方系统 Web 页面内嵌日志服务的检索分析页面,显示顶部 TopicBar 和左侧导航栏,默认展示指定 Topic 的数据,设置默认的检索分析语句,指定查询日志的时间范围为近 1 小时。
在显示效果上,隐藏左侧导航栏、页面标题栏、Topic 选择框、分享按钮及设置索引按钮。

https://console.volc-embed.com/tls/region:tls+cn-beijing/project/e783ddd1-f07e-404f-b167-915d04d6****/search?topicId=999ecfa1-9eed-4cb4-ac2e-e130f656****&time=now-1h,now&codebase64=KiB8IHNlbGVjdCAq&hideTitle=true&hideTopic=true&hideIndexBtn=true&hideLeftBar=true&hideShareBtn=true

显示效果如下:
图片