文档中心

DescribeLogContext

最近更新时间：2024.04.19 13:54:13

首次发布时间：2022.07.12 11:09:18

调用接口 DescribeLogContext 查看指定日志的上下文信息。

使用说明

日志服务支持在检索日志时查看指定日志在日志源文件中的上下文信息。调用接口 SearchLogs 之后，可以通过此接口进一步查看指定日志的上下文信息。

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

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

说明

仅 1.0.6 及后续版本的 LogCollector 采集到的日志支持上下文查询，通过 SDK 调用 PutLogs 接口等其他方式上传的日志数据不支持上下文查询。
使用上下文查询功能之前，需要先为日志主题配置索引。详细信息请参考 CreateIndex。

请求说明

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

请求参数

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

Body

参数	类型	是否必选	示例值	描述
TopicId	String	是	`4a******`	日志主题 ID。
ContextFlow	String	是	`e61050c-f7b3a4bf-2`	指定日志所在的 LogGroup 的 ID。您可以在 SearchLogs 接口的返回信息的 Logs 中获取该 ID。
PackageOffset	Long	是	`66`	指定日志在 LogGroup 的序号。您可以在 SearchLogs 接口的返回信息的 Logs 中获取该序号。
Source	String	是	`127...**`	日志来源主机 IP。
PrevLogs	Integer	否	`10`	指定日志的上文日志条数，即往前查看多少条日志。取值范围为 1~1000，默认值为 10。
NextLogs	Integer	否	`10`	指定日志的下文日志条数，即往后查看多少条日志。取值范围为 1~1000，默认值为 10。

返回参数

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

参数类型示例值描述

参数	类型	示例值	描述
LogContextInfos	Array of JSON Map	`/`	指定日志的上下文日志信息。按上下文顺序排列。当根据指定起始日志查询不到上下文日志时，此参数为空。其中，LogContextInfos 中以键值对的方式展示每条日志内容，除此之外每条日志还包含以下两个字段： `___context_flow__`：该日志所在的 LogGroup 的 ID。 `__package_offset__`：该日志在 LogGroup 的序号。
PrevOver	Boolean	`true`	除 LogContextInfos 中的日志以外，是否还存在其他上文。 true：存在。 false：不存在。
NextOver	Boolean	`true`	除 LogContextInfos 中的日志以外，是否还存在其他下文。 true：存在。 false：不存在。

LogContextInfos

Array of JSON Map

/

指定日志的上下文日志信息。按上下文顺序排列。当根据指定起始日志查询不到上下文日志时，此参数为空。

其中，LogContextInfos 中以键值对的方式展示每条日志内容，除此之外每条日志还包含以下两个字段：

___context_flow__：该日志所在的 LogGroup 的 ID。
__package_offset__：该日志在 LogGroup 的序号。

PrevOver

Boolean

true

除 LogContextInfos 中的日志以外，是否还存在其他上文。

true：存在。
false：不存在。

NextOver

Boolean

true

除 LogContextInfos 中的日志以外，是否还存在其他下文。

true：存在。
false：不存在。

请求示例

POST https://tls-{Region}.ivolces.com/DescribeLogContext HTTP/1.1
Content-Type: application/json
{
    "TopicId":"0fa67c30-d8e3-407f-a1d9-39d55cb7****",
    "ContextFlow":"e61050c909dcccc3-f7b3a4bfaf6af941-8",
    "PackageOffset":4,
    "Source":"127.**.**.**",
    "PrevLogs":10,
    "NextLogs":10
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length:  0
{
    "LogContextInfos": [
       {
            "__context_flow__": "e61050c909dcccc3-f7b3a4bfaf6af941-2",
            "__package_offset__": "3",
            "__path__": "/root/my_script/tls-conf-master/input_logs/log/hashkey.log",
            "__source__": "127.**.**.**",
            "__time__": 1655788239654,
            "d": "1.23",
            "index": "7",
            "l": "987654321",
            "l1": "12344566789",
            "str": "hhhhhhhhh"
        },
        {
            "__context_flow__": "e61050c909dcccc3-f7b3a4bfaf6af941-2",
            "__package_offset__": "4",
            "__path__": "/root/my_script/tls-conf-master/input_logs/log/hashkey.log",
            "__source__": "127.**.**.**",
            "__time__": 1655788239654,
            "d": "1.23",
            "index": "7",
            "l": "987654321",
            "l1": "12344566789",
            "str": "hhhhhhhhh"
        },
        {
            "__context_flow__": "e61050c909dcccc3-f7b3a4bfaf6af941-2",
            "__package_offset__": "5",
            "__path__": "/root/my_script/tls-conf-master/input_logs/log/hashkey.log",
            "__source__": "127.**.**.**",
            "__time__": 1655788239654,
            "d": "1.23",
            "index": "7",
            "l": "987654321",
            "l1": "12344566789",
            "str": "hhhhhhhhh"
        }
    ],
    "PrevOver": true,
    "NextOver": true
}

错误码

您可访问公共错误码，获取更多错误码信息。