1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于搜索日志上下文附近的内容
默认接口请求频率限制：20次/秒。
接口更新时间：2025-01-15 01:14:03。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeLogContext |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| 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 | 是 | 否 | Int64 | 日志包内一条日志的序号，即SearchLog接口返回信息中Results结构中的PkgLogId。 示例值： 65536 |
| PrevLogs | 否 | 否 | Int64 | 前${PrevLogs}条日志，默认值10。 示例值： 10 |
| NextLogs | 否 | 否 | Int64 | 后${NextLogs}条日志，默认值10。 示例值： 10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LogContextInfos | Array of LogContextInfo | 日志上下文信息集合 示例值：查看 |
| PrevOver | Bool | 上文日志是否已经返回完成（当PrevOver为false，表示有上文日志还未全部返回）。 示例值： true |
| NextOver | Bool | 下文日志是否已经返回完成（当NextOver为false，表示有下文日志还未全部返回）。 示例值： true |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |
| FailedOperation.SearchTimeout | 查询超时。 |
| FailedOperation.TopicIsolated | 日志主题已隔离。 |
| FailedOperation.QueryError | 查询语句运行失败。 |
| FailedOperation.InvalidContext | 检索游标已失效或不存在。 |
| FailedOperation.SyntaxError | 查询语句解析错误。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |