调用 SearchLogs 接口检索日志。

使用说明

检索相关的接口（SearchLogs、DescribeLogContext 和 DescribeHistogram）共用一个调用频率和并发限制的额度，具体限制如下：

• 针对单个火山引擎账号或 IAM 用户，日志检索的请求频率限制为 100 次/秒，否则会收到报错 ExceedQPSLimit。
• 针对单个日志主题，日志检索并发数限制为 15，否则会收到报错ExceedCountLimit。

注意事项

• SearchLogs 接口的请求头中，“X-Tls-Apiversion” 应指定为“0.3.0”。其他请求头参数说明请参考公共参数。
• 日志服务采用火山引擎统一的签名机制。详细说明，请参考签名机制。

请求说明

• 请求方式：POST
• 请求地址：https://tls-{Region}.ivolces.com/SearchLogs

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

AnalysisResult

请求示例 1

全文检索

POST https://tls-{Region}.ivolces.com/SearchLogs HTTP/1.1
Content-Type: application/json
{
    "TopicId":"c1***********",
    "Query":"error",
    "StartTime":1346457600000,
    "EndTime":1630454400000,
    "Limit":30,
    "Sort":"desc"
}

返回示例 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length:  0
{
    "ResultStatus": "complete",
    "HitCount": 20,  // 搜索匹配的总条目数
    "Count": 0,      // sql检索的结果命中行数
    "Limit": 0,      // sql检索的limit条数
    "ListOver":false,
    "Analysis":false,
    "Context":"[1650349469000,130,9,null]",
    "Logs": [
        {
            "__path__": "/root/my_script/tls-conf-master/input_logs/log/hashkey.log",    
            "__source__": "10.17.0.2",  
            "__time__": "1655788239654",    
            "__content__": "", 
            "__context_flow__":"e61050c909dcccc3-f7b3a4bfaf6af941-2",
            "__package_offset__":"3"
        },
        ...
    ],
    "AnalysisResult": {
        "Schema": [],
        "Type": {},
        "Data": []
    }
}

请求示例 2

键值检索

POST https://tls-{Region}.ivolces.com/SearchLogs HTTP/1.1
Content-Type: application/json
{
    "TopicId":"c1**********",
    "Query":"name:xiaoming",
    "StartTime":1346457600000,
    "EndTime":1630454400000,
    "Limit":30,
    "Sort":"desc"
}

返回示例 2

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length:  0
{
    "ResultStatus": "complete",
    "HitCount": 20, // 搜索匹配的总条目数
    "Count": 0, // sql检索的结果命中行数
    "Limit": 0, // sql检索的limit条数
    "ListOver": false,
    "Analysis": false,
    "Context": "[1650349469000,130,9,null]",
    "Logs": [
        [
            {
                "__path__": "/root/my_script/tls-conf-master/input_logs/log/hashkey.log",
                "__source__": "10.17.0.2",
                "__time__": "1655788239654",
                "__context_flow__": "e61050c909dcccc3-f7b3a4bfaf6af941-2",
                "__package_offset__": "3",
                "age": "xxx",
                "class": "xxx"
            },
        ],
        "AnalysisResult": {
            "Schema": [],
            "Type": {},
            "Data": []
        }
    }

请求示例 3

SQL分析

POST https://tls-{Region}.ivolces.com/SearchLogs HTTP/1.1
Content-Type: application/json
{
    "TopicId":"c1***********",
    "Query":"* | select name, age, address",
    "StartTime":1346457600000,
    "EndTime":1630454400000,
    "Limit":30,
    "Sort":"desc"
}

返回示例 3

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length:  0
{
    "ResultStatus": "complete",
    "Analysis": true,
    "ListOver": true,
    "HitCount": 5924,
    "Count": 1, // sql检索的结果命中行数
    "Limit": 1, // sql检索的limit条数
    "Logs": [],
    "AnalysisResult": {
        "Schema": [
            "name",
            "age",
            "address"
        ],
        "Type": {
            "name": "text",
            "age": "long",
            "address": "text"
        },
        "Data": [
            {
                "name": "zhangsan",
                "age": "29",
                "address": "zhengjiang"
            }
        ]
    },
    "Context": ""
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。