搜索日志
最近更新时间: 2024-10-18 10:38:39
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于检索分析日志, 该接口除受默认接口请求频率限制外，针对单个日志主题，查询并发数不能超过15。
默认接口请求频率限制：10000次/秒。
接口更新时间：2022-10-31 11:10:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：SearchLog |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| TopicId | 是 | 否 | String | 要查询的日志主题ID |
| From | 是 | 否 | Int64 | 要查询的日志的起始时间，Unix时间戳，单位ms |
| To | 是 | 否 | Int64 | 要查询的日志的结束时间，Unix时间戳，单位ms |
| Query | 是 | 否 | String | 查询语句，语句长度最大为4096 |
| Limit | 否 | 否 | Int64 | 单次查询返回的原始日志条数，最大值为100。查询语句(Query)包含SQL时，针对SQL的结果条数需在Query中指定，参考https://cloud.tencent.com/document/product/614/58977 |
| Context | 否 | 否 | String | 加载更多日志时使用，透传上次返回的Context值，获取后续的日志内容。过期时间1小时 |
| Sort | 否 | 否 | String | 日志接口是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc |
| HighLight | 否 | 否 | Bool | 此参数对外不可见。 是否返回检索的高亮结果 |
| UseNewAnalysis | 否 | 否 | Bool | 为true代表使用新检索,响应参数AnalysisRecords和Columns有效， 为false时代表使用老检索方式, AnalysisResults和ColNames有效 |
| QueryOptimize | 否 | 否 | Uint64 | 0：不执行语法优化；1：执行语法优化 |
| SamplingRate | 否 | 否 | Float | 0：表示客户选择auto自动采样率; 0～1之间：表示客户指定的采样率（例如0.02; 1（默认值）：表示不采样。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Context | String | 此参数对外不可见。 加载后续内容的Context，过期时间1小时 |
| ListOver | Bool | 此参数对外不可见。 原始日志查询结果是否全部返回。查询语句(Query)包含SQL时该参数无意义 |
| Analysis | Bool | 此参数对外不可见。 返回的是否为分析结果 |
| ColNames | String | 此参数对外不可见。 如果Analysis为True，则返回分析结果的列名，否则为空 |
| Results | LogInfo | 此参数对外不可见。 日志查询结果；当Analysis为True时，可能返回为null |
| AnalysisResults | LogItems | 此参数对外不可见。 日志分析结果；当Analysis为False时，可能返回为null |
| AnalysisRecords | String | 此参数对外不可见。 新的日志分析结果; UseNewAnalysis为true有效 |
| Columns | Column | 此参数对外不可见。 日志分析的列属性; UseNewAnalysis为true有效 |
| Query | String | 此参数对外不可见。 返回语法优化后的语句（QueryOptimize 为 1 时返回，其他情况返回空字符串） |
| SamplingRate | Float | 此参数对外不可见。 当前系统使用的采样率SamplingRate（主要是当客户输入0时，返回真实后台的AutoSamplingRate值） |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| MissingParameter | |
| InternalError | |
| FailedOperation | |
| OperationDenied | |
| ResourceNotFound.TopicNotExist | |
| FailedOperation.SearchTimeout | |
| FailedOperation.TopicIsolated | |
| FailedOperation.QueryError | |
| FailedOperation.InvalidContext | |
| FailedOperation.SyntaxError | |
| LimitExceeded.LogSearch | |
| OperationDenied.AccountIsolate | |
| OperationDenied.AccountDestroy | |
| OperationDenied.AccountNotExists |