1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于构建直方图
默认接口请求频率限制：20次/秒。
接口更新时间：2025-01-15 01:29:35。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeLogHistogram |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| TopicId | 否 | 否 | String | 要查询的日志主题ID 示例值： 682d0718-07bb-4ec0-9fda-f1e9a2767e0b |
| From | 是 | 否 | Int64 | 要查询的日志的起始时间，Unix时间戳，单位ms 示例值： 1608794855000 |
| To | 是 | 否 | Int64 | 要查询的日志的结束时间，Unix时间戳，单位ms 示例值： 1608794855000 |
| Query | 是 | 否 | String | 查询语句 示例值： http_status:200 |
| Interval | 否 | 否 | Int64 | 时间间隔: 单位ms 限制性条件：(To-From) / interval <= 200 示例值： 10 |
| QueryOptimize | 否 | 否 | Uint64 | 0（默认值）：不执行语法优化；1：执行语法优化。 示例值： 0 |
| SyntaxRule | 否 | 否 | Uint64 | 检索语法规则，默认值为0。 0：Lucene语法，1：CQL语法。 详细说明参见检索条件语法规则 示例值： 1 |
| TopicIds | 否 | 否 | Array of String | 要检索分析的日志主题ID列表。TopicId和TopicIds二个参数只能选择其中一个参数进行查询。 示例值： ["682d0718-07bb-4ec0-9fda-f1e9a2767e0b"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Interval | Int64 | 统计周期： 单位ms 示例值： 10 |
| TotalCount | Int64 | 命中关键字的日志总条数 示例值： 12 |
| HistogramInfos | Array of HistogramInfo | 周期内统计结果详情 示例值：查看 |
| Query | String | 返回语法优化后的语句（QueryOptimize 为 1 时返回，其他情况返回空字符串） 示例值： message.retcode:0 AND message.reqsource:mc |
| 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 | 账户不存在。 |