配置控制台内嵌参数

所有UI参数均通过URL格式进行控制，URL格式示例如下：

https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?参数1&参数2

URL参数及效果示例如下所示：

• 使用如下URL隐藏当前Project控制台的返回按钮、Project切换按钮、Project概览入口。

  https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?hiddenBack=true&hiddenChangeProject=true&hiddenOverview=true

  
• 使用如下URL隐藏当前Project控制台的返回按钮。

  https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?hiddenBack=true

  
• 使用如下URL设置查询和分析时间。

  https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?queryTimeType=3

  

URL参数及效果示例如下所示：

• 使用如下URL设置查询和分析语句。

  例如*|select count(*)语句经过BASE 64编码后为KnxzZWxlY3QgY291bnQoKik=。

  https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?encode=base64&queryString=KnxzZWxlY3QgY291bnQoKik=

  
• 使用如下URL隐藏编辑、修改相关的按钮，例如查询分析属性、另存为告警等。

  https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?readOnly=true

  
• 使用如下URL隐藏Logstore的统计图表和日志聚类页签。

  https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?hiddenLogChart=true&hiddenLogReduce=true

  

URL参数及效果示例如下所示：

https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/savedsearch/${savedsearchID}

URL参数及效果示例如下所示：

• 使用如下URL使仪表盘页面为只读模式。

  https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/dashboard/${dashboardID}?readOnly=true 

  
• 使用如下URL为仪表盘增加两个过滤条件key1=value1和key2=value2。其中，过滤条件filters=key1:value1&filters=key2:value2经过转码后为filters%3Dkey1%3Avalue1%26filters%3Dkey2%3Avalue2。

  https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/dashboard/${dashboardID}?filters%3Dkey1%3Avalue1%26filters%3Dkey2%3Avalue2

  
• 使用如下URL增加多个变量替换条件projectname=1和region=hangzhou。其中token=[{"key": "projectname","value":"1"}, {"key": "region", "value": "hangzhou"}]经过转码后为token=%5B%7B%22key%22%3A%20%22projectname%22%2C%22value%22%3A%221%22%7D%2C%20%7B%22key%22%3A%20%22region%22%2C%20%22value%22%3A%20%22hangzhou%22%7D%5D

  https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/dashboard/${dashboardID}?token=%5B%7B%22key%22%3A%20%22projectname%22%2C%22value%22%3A%221%22%7D%2C%20%7B%22key%22%3A%20%22region%22%2C%20%22value%22%3A%20%22hangzhou%22%7D%5D

  
• 使用如下URL使仪表盘每5分钟刷新一次。

  https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/dashboard/${dashboardId}?autoFresh=5m

  

treeConfig参数完整示例如下所示：

{
    "logstore": { 
        "search": true, 
        "expand": true, 
        "resourceList": [ 
            "L1",
            "L2"
        ],
        "template": [
            "favor", 
            "logtail",
            "import", 
            "etl", 
            "savedsearch",
            "alert",
            "export", 
            "consumergroup", 
            "dashboard" 
        ]
    },
    "machineGroup": {
        "search": true,
        "resourceList": [
            "m1",
            "m2"
        ]
    },
    "savedSearch": {
        "search": true,
        "resourceList": [
            "s1",
            "s2"
        ]
    },
    "alarm": {
        "search": true,
        "resourceList": [
            "a1",
            "a2"
        ]
    },
    "dashboard": {
        "search": true,
        "resourceList": [
            "d1",
            "d2"
        ]
    },
    "etl": {
        "search": true,
        "resourceList": [
            "e1",
            "e2"
        ]
    }
}

表 2. treeConfig参数说明

参数名	类型	是否必选	说明
logstore	object	否	用于控制Logstore列表中的资源入口。
template	string[]	否	用于控制Logstore列表中的一些功能入口。更多信息，请参见template参数说明。
machineGroup	object	否	用于控制机器组列表中的资源入口。
savedSearch	object	否	用于控制快速查询列表中的资源入口。
alert	object	否	用于控制告警列表中的资源入口。
dashboard	object	否	用于控制仪表盘列表中的资源入口。
etl	object	否	用于控制数据加工列表中的资源入口。

表 3. 资源相关参数说明

参数名	类型	是否必选	说明
search	boolean	否	是否显示搜索框。默认为true，表示显示。
resourceList	String[]	否	显示当前资源的列表。如果为空数组，则显示空列表；如果不设置该参数，则全部显示，精准匹配。默认显示全部列表。
expand	boolean	否	是否展开列表。默认为false，表示不展开，仅针对Logstore列表有效。

表 4. template参数说明

参数名	类型	是否必选	说明
favor	string	否	我的关注
logtail	string	否	Logtail配置
import	string	否	数据导入
etl	string	否	数据加工
savedsearch	string	否	快速查询
alert	string	否	告警
export	string	否	数据导出
consumergroup	string	否	数据消费
dashboard	string	否	可视化仪表盘

使用如下URL设置左侧导航栏。

https://sls4service.console.aliyun.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?treeconfig=eyJsb2dzdG9yZSI6eyJleHBhbmQiOnRydWUsInJlc291cmNlTGlzdCI6WyJkZWxldGUtbG9nIl0sInRlbXBsYXRlIjpbInNhdmVkc2VhcmNoIiwiYWxlcnQiXX19&hiddenBack=true&hiddenChangeProject=true&hiddenOverview=true&treeEncode=base64&ignoreTabLocalStorage=true

对于外层iframe的高度可以通过日志服务postmessage的dashboardHeight来获取，并设置为iframe高度。示例代码如下所示：

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>POST message测试</title>
</head>
<style>
  * {
    padding: 0;
    margin: 0;
  }

  iframe {
    display: block;
    width: 100%;
  }
</style>
<body>
  <script>
    window.addEventListener('message',function(e){
      console.log(e.data.dashboardHeight)
      document.getElementById('test').style.height = e.data.dashboardHeight + 'px'
    });
  </script>
  <div style="height: 700px;">somethings</div>
  <iframe id="test" src="http://sls4service.console.aliyun.com/lognext/project/${projectName}/dashboard/${dashboardName}?product=${productCode}">
</body>
</html>