云日志服务 LTS-将LTS日志查询页面嵌入用户自建系统:云日志服务地址说明

时间:2024-10-30 17:09:29

云日志 服务地址说明

  1. 云日志服务首页,基础URL为:
    https://console.huaweicloud.com/lts/?region={regionId}&cfModuleHide=header_sidebar_floatlayer#/cts/manager/groups
    表3 参数说明表

    参数名称

    必填

    类型

    描述

    regionId

    String

    区域ID,登录console页面后在浏览器的地址栏中获取。

  2. 日志搜索界面,基础URL为:
    https://console.huaweicloud.com/lts/?region={regionId}&cfModuleHide=header_sidebar_floatlayer#/cts/logEventsLeftMenu/events?groupId={groupId}&topicId={topicId}&epsId={epsId}&hideHeader={hideHeader}&fastAnalysisCollapsed={fastAnalysisCollapsed}&hideDashboard={hideDashboard}&hideFeedback={hideFeedback}&isFoldLabel={isFoldLabel}&hideStreamName={hideStreamName}&showK8sFilter={showK8sFilter}&clusterId={clusterId}&hideBarChart={hideBarChart}&hideTabs={hideTabs}&condition={condition}
    表4 参数说明表c

    参数名称

    必填

    类型

    默认值

    描述

    regionId

    String

    区域ID,登录console页面后在浏览器的地址栏中获取。

    groupId

    String

    日志组ID。

    topicId

    String

    日志流ID。

    epsId

    String

    日志流所属的企业项目ID,若无企业项目,值为0。

    hideHeader

    Boolean

    false

    是否隐藏左侧列表及顶部横向日志流列表,如需隐藏,该参数值为true。

    说明:

    使用iframe内嵌场景才会生效,不使用iframe内嵌场景则不生效。

    fastAnalysisCollapsed

    Boolean

    false

    是否收起快速分析,如需默认收起,该参数值为true。

    hideDashboard

    Boolean

    false

    是否隐藏创建仪表盘图标,如需隐藏,该参数值为true。

    hideFeedback

    Boolean

    false

    是否隐藏评价按钮,如需隐藏,该参数值为true。

    isFoldLabel

    Boolean

    true

    控制日志表格中的label字段是否换行,如需换行展示,该参数值为true。

    hideStreamName

    Boolean

    false

    是否隐藏日志流名称,如需隐藏,该参数值为true。

    showK8sFilter

    Boolean

    false

    是否展示容器日志筛选,容器日志搜索场景下,可选择该参数为true,控制是否展示容器日志筛选条件。

    clusterId

    String

    集群ID,showK8sFilter参数为true时,该参数必填。

    hideBarChart

    Boolean

    false

    是否默认收起日志条数统计图,如需默认收起,该参数值为true。

    hideTabs

    Boolean

    false

    是否隐藏“日志搜索、 日志分析 、实时日志”标签tabs,默认不隐藏。如需隐藏,该参数值为true。

    hideShare

    Boolean

    false

    是否隐藏“分享”按钮,默认不隐藏。如需隐藏,该参数值为true。(当前仅华北-北京四局点支持该参数)

    condition

    String

    日志查询条件,如name:a and age:12 and addr:xx。

    • 非必填
    • 单个关键词形式为key:value
    • 多个关键词用 and 隔开
    • 关键词中不能包含英文分号(;)、英文冒号(:)
    • 关键词中含有其他特殊字符如(+、=、?、#、%、&)需转换为十六进
    图6 参数与界面对应关系图(仅供参考)
  3. 可视化日志搜索界面,基础URL为:

    https://console.huaweicloud.com/lts/?region={regionId}&cfModuleHide=header_sidebar_floatlayer#/cts/logEventsLeftMenu/events?visualization=true&groupId={groupId}&topicId={topicId}&epsId={epsId}&sql={sql}
    表5 参数说明表

    参数名称

    必填

    类型

    默认值

    描述

    regionId

    String

    区域ID,登录console页面后在浏览器的地址栏中获取。

    groupId

    String

    日志组ID。

    topicId

    String

    日志流ID。

    epsId

    String

    日志流所属的企业项目ID,若无企业项目,值为0。

    hideHeader

    Boolean

    false

    是否隐藏左侧列表及顶部横向日志流列表,如需隐藏,该参数值为true。

    sql

    String

    SQL查询语句,如SELECT count (*)。

    图7 参数与界面对应关系图(仅供参考)
  4. 仪表盘界面,基础URL为:
    https://console.huaweicloud.com/lts/?region={regionId}&cfModuleHide=header_sidebar_floatlayer#/cts/manager/dashboard?dashboardId={dashboardId}&hideDashboardList={hideDashboardList}&showCurrentdashboardGroup={showCurrentdashboardGroup}&streamId={streamId}&streamDisabled={streamDisabled}&readonly={readonly}&filter=key1:value1,value2;key2:value3,value4&autoFresh={autoFresh}
    表6 参数说明表

    参数名称

    必填

    类型

    默认值

    描述

    示例

    regionId

    String

    区域ID,登录console页面后在浏览器的地址栏中获取。

    region=xx-xx-xx

    dashboardId

    String

    需要展示的仪表盘ID,默认值为""。

    使用场景:当用户需要默认展示某仪表盘时,可添加此参数。

    dashboardId=xxxxxxxx

    hideDashboardList

    Boolean

    false

    是否隐藏仪表盘选择下拉列表:默认不隐藏,true表示隐藏。

    使用场景:当用户需要隐藏仪表盘下拉列表时,可通过添加该参数且值为true来实现。

    hideDashboardList=true

    showCurrentdashboardGroup

    Boolean

    false

    是否只展示当前仪表盘所在分组/模板:默认值为false。

    使用场景:当用户只需要展示当前仪表盘分组/模板的仪表盘时,可通过添加该参数且值为true来实现。

    注意:若hideDashboardList参数值为true时,当前参数无效。

    showCurrentdashboardGroup=true

    streamId

    String

    日志流ID:默认值为""。

    使用场景:只适用于仪表盘模板。当用户需要默认选中某日志流时,可添加该参数。

    streamId=xxxxxx

    streamDisabled

    Boolean

    false

    日志流下拉框:默认可选择,true标识不可选择

    使用场景:只适用于仪表盘模板。当用户需要置灰日志流下拉框时,可添加该参数。

    streamDisabled=true

    filter

    String

    过滤器参数,值为要选中的过滤器的名称及选中项。

    key1、key2为过滤器名称,value1、value2为过滤器key1需要选中的值,value3、value4为过滤器key2需要选中的值。多个过滤器按照;分隔,多个选中项按照,分隔。

    使用场景:当用户内嵌仪表盘界面需要默认选中某些过滤器的key、value时,可添加该参数。

    filter=key1:value1,value2;key2:value3,value4

    readonly

    Boolean

    false

    是否是只读场景,只读场景下,操作类按钮会被隐藏。例如:新建过滤器、添加/修改/删除仪表盘等。

    使用场景:当用户只需要展示仪表盘,不需要操作权限时,可添加该参数。

    readonly=true

    autoFresh

    String

    定时刷新时长,默认值为""。

    使用场景:当用户需要指定默认定时刷新时长时,可添加此参数,当前支持的定时刷新时长参数取值为:0m,1m,5m,15m之一,对应:不定时刷新、1分钟定时刷新、5分钟定时刷新、15分钟定时刷新。

    autoFresh=1m

    图8 参数与界面对应关系图(仅供参考)
support.huaweicloud.com/bestpractice-lts/lts_07_0006.html