上下文检索

最近更新时间:2024-05-30 01:22:27

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

本接口用于搜索日志上下文附近的内容,详情参考上下文检索
API返回数据包最大49MB,建议启用 gzip 压缩(HTTP Request Header Accept-Encoding:gzip)。

默认接口请求频率限制:20次/秒。

此接口支持如下压缩格式返回:gzip

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLogContext。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
TopicId String 要查询的日志主题ID
示例值:682d0718-07bb-4ec0-9fda-f1e9a2767e0b
BTime String 日志时间, 即SearchLog接口返回信息中Results结构体中的Time,需按照 UTC+8 时区将该毫秒级Unix时间戳转换为 YYYY-mm-dd HH:MM:SS.FFF 格式的字符串。
示例值:2021-04-25 14:25:00.000
PkgId String 日志包序号,即SearchLog接口返回信息中Results结构体中的PkgId。
示例值:528C1318606EFEB8-1A7
PkgLogId Integer 日志包内一条日志的序号,即SearchLog接口返回信息中Results结构中的PkgLogId。
示例值:65536
PrevLogs Integer 前${PrevLogs}条日志,默认值10。
示例值:10
NextLogs Integer 后${NextLogs}条日志,默认值10。
示例值:10
Query String 检索语句,对日志上下文进行过滤,最大长度为12KB
语句由 [检索条件]构成,不支持SQL语句
示例值:http_status:200
From Integer 上下文检索的开始时间,单位:毫秒级时间戳
注意:
- From为空时,表示上下文检索的开始时间不做限制
- From和To非空时,From < To
- 暂时仅支持上海 / 弗吉尼亚/ 新加坡地域
示例值:1716532075000
To Integer 上下文检索的结束时间,单位:毫秒级时间戳。
注意:
- To为空时,表示上下文检索的结束时间不做限制
- From和To非空时,From < To
- 暂时仅支持上海 / 弗吉尼亚/ 新加坡地域
示例值:1716532085000

3. 输出参数

参数名称 类型 描述
LogContextInfos Array of LogContextInfo 日志上下文信息集合
PrevOver Boolean 上文日志是否已经返回完成(当PrevOver为false,表示有上文日志还未全部返回)。
示例值:true
NextOver Boolean 下文日志是否已经返回完成(当NextOver为false,表示有下文日志还未全部返回)。
示例值:true
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 检索上下文日志

检索上下文日志

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogContext
<公共请求参数>

{
    "TopicId": "682d0718-07bb-4ec0-9fda-f1e9a2767e0b",
    "BTime": "2021-04-25 14:25:00.000",
    "PkgId": "528C1318606EFEB8-1A7",
    "PkgLogId": 65536,
    "PrevLogs": 10,
    "NextLogs": 10
}

输出示例

{
    "Response": {
        "LogContextInfos": [
            {
                "BTime": 1706685527008,
                "Content": "{\"create_time\":\"2022-06-07 17:17:10\",\"Caller\":\"cache/topic.go:92\",\"Time\":\"2024-01-31 15:18:46\",\"Level\":\"INFO\"}",
                "Filename": "/var/log/cls_cgi.log",
                "HighLights": [
                    {
                        "Key": "user_topic_id",
                        "Values": [
                            "<cls_highlight>74ee1b12-9b3d-4a2b-80dd-8322c74126fb</cls_highlight>"
                        ]
                    }
                ],
                "HostName": "eks",
                "IndexStatus": "",
                "PkgId": "5BD4618A65B32B70-117",
                "PkgLogId": 30736474,
                "RawLog": "",
                "Source": "9.148.222.202"
            },
            {
                "BTime": 1706685528008,
                "Content": "{\"create_time\":\"2022-06-07 17:17:10\",\"Caller\":\"cache/topic.go:92\",\"Time\":\"2024-01-31 15:18:46\",\"Level\":\"INFO\"}",
                "Filename": "/var/log/cls_cgi.log",
                "HighLights": [
                    {
                        "Key": "user_topic_id",
                        "Values": [
                            "<cls_highlight>74ee1b12-9b3d-4a2b-80dd-8322c74126fb</cls_highlight>"
                        ]
                    }
                ],
                "HostName": "eks",
                "IndexStatus": "",
                "PkgId": "5BD4618A65B32B70-118",
                "PkgLogId": 42008582,
                "RawLog": "",
                "Source": "9.148.222.202"
            }
        ],
        "NextOver": true,
        "PrevOver": true,
        "RequestId": "0d6109ac-e925-4670-9ccc-dc2bd4024a32"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.InvalidContext 检索游标已失效或不存在。
FailedOperation.QueryError 查询语句运行失败。
FailedOperation.SearchTimeout 查询超时。
FailedOperation.SyntaxError 查询语句解析错误。
FailedOperation.TopicIsolated 日志主题已隔离。
InternalError 内部错误。
InternalError.SearchFailed 检索失败
InvalidParameter 参数错误。
LimitExceeded.LogSearch 并发查询超过限制,单topic并发最大值15。
LimitExceeded.SearchResultTooLarge 检索接口返回的日志量太大, 超过20MB限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。
ResourceNotFound.TopicNotExist 日志主题不存在。