上下文检索

1. 接口描述

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

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

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

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

2. 输入参数

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

3. 输出参数

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。

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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