1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于检索分析日志, 该接口除受默认接口请求频率限制外，针对单个日志主题，查询并发数不能超过15。
默认接口请求频率限制：10000次/秒。
接口更新时间：2025-01-17 19:57:14。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：SearchLog |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| TopicId | 否 | 否 | String | 要检索分析的日志主题ID，仅能指定一个日志主题。 如需同时检索多个日志主题，请使用Topics参数。 TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。 示例值： 682d0718-07bb-4ec0-9fda-f1e9a2767e0b |
| From | 是 | 否 | Int64 | 要检索分析的日志的起始时间，Unix时间戳（毫秒） 示例值： 1608794854000 |
| To | 是 | 否 | Int64 | 要检索分析的日志的结束时间，Unix时间戳（毫秒） 示例值： 1608794855000 |
| Query | 是 | 否 | String | 检索分析语句，最大长度为12KB 语句由 [检索条件] |
| Limit | 否 | 否 | Int64 | 表示单次查询返回的原始日志条数，默认为100，最大值为1000。 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果条数指定方式参考SQL LIMIT语法 可通过两种方式获取后续更多日志： Context:透传上次接口返回的Context值，获取后续更多日志，总计最多可获取1万条原始日志 Offset:偏移量，表示从第几行开始返回原始日志，无日志条数限制 示例值： 100 |
| Context | 否 | 否 | String | 透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。 注意： 透传该参数时，请勿修改除该参数外的其它参数 仅适用于单日志主题检索，检索多个日志主题时，请使用Topics中的Context 仅当检索分析语句(Query)不包含SQL时有效，SQL获取后续结果参考SQL LIMIT语法 示例值： Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy |
| Sort | 否 | 否 | String | 原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果排序方式参考SQL ORDER BY语法 示例值： asc |
| HighLight | 否 | 否 | Bool | 是否返回符合检索条件的关键词，一般用于高亮显示匹配的关键词，仅支持键值检索 示例值： false |
| UseNewAnalysis | 否 | 否 | Bool | 为true代表使用新的检索结果返回方式，输出参数AnalysisRecords和Columns有效 为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效 两种返回方式在编码格式上有少量区别，建议使用true 示例值： false |
| QueryOptimize | 否 | 否 | Uint64 | 0：不执行语法优化；1：执行语法优化 示例值： 0 |
| SamplingRate | 否 | 否 | Float | 执行统计分析（Query中包含SQL）时，是否对原始日志先进行采样，再进行统计分析。 0：自动采样; 0～1：按指定采样率采样，例如0.02; 1：不采样，即精确分析 默认值为1 示例值： 0.1 |
| SyntaxRule | 否 | 否 | Uint64 | 检索语法规则，默认值为0，推荐使用1 。 0：Lucene语法 1：CQL语法（日志服务专用检索语法，控制台默认也使用该语法规则）。 详细说明参见检索条件语法规则 示例值： 1 |
| Topics | 否 | 否 | Array of MultiTopicSearchInformation | 要检索分析的日志主题列表，最大支持50个日志主题。 检索单个日志主题时请使用TopicId。 TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。 示例值：查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Context | String | 透传本次接口返回的Context值，可获取后续更多日志，过期时间1小时。 注意： 仅适用于单日志主题检索，检索多个日志主题时，请使用Topics中的Context 示例值： Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy |
| ListOver | Bool | 符合检索条件的日志是否已全部返回，如未全部返回可使用Context参数获取后续更多日志 注意：仅当检索分析语句(Query)不包含SQL时有效 示例值： false |
| Analysis | Bool | 返回的是否为统计分析（即SQL）结果 示例值： false |
| ColNames | Array of String | 日志统计分析结果的列名 当UseNewAnalysis为false时生效 示例值： ["col1"] |
| Results | Array of LogInfo | 匹配检索条件的原始日志 示例值：查看 |
| AnalysisResults | Array of LogItems | 日志统计分析结果 当UseNewAnalysis为false时生效 示例值：查看 |
| AnalysisRecords | Array of String | 日志统计分析结果 当UseNewAnalysis为true时生效 示例值： ["record1"] |
| Columns | Array of Column | 日志统计分析结果的列属性 当UseNewAnalysis为true时生效 示例值：查看 |
| Query | String | 返回语法优化后的语句（QueryOptimize 为 1 时返回，其他情况返回空字符串） 示例值： message.retcode:0 AND message.reqsource:mc |
| SamplingRate | Float | 本次统计分析使用的采样率 示例值： 0.1 |
| Border | Int64 | 日志沉降边界。Unix时间戳（毫秒），在border之前的数据为冷存储，border之后的为标准存储。 示例值： 0 |
| Topics | SearchLogTopics | 使用多日志主题检索时，各个日志主题的基本信息，例如报错信息。 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |
| FailedOperation.SearchTimeout | 查询超时。 |
| FailedOperation.TopicIsolated | 日志主题已隔离。 |
| FailedOperation.QueryError | 查询语句运行失败。 |
| FailedOperation.InvalidContext | 检索游标已失效或不存在。 |
| FailedOperation.SyntaxError | 查询语句解析错误。 |
| LimitExceeded.LogSearch | 并发查询超过限制，单topic并发最大值15。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |