日志服务提供新版接口 DescribeHistogramV1 用于检索日志,查看满足条件的日志数据随时间分布的情况。
此接口用于检索日志,并构建日志检索结果的直方图。
检索相关的接口(SearchLogs、DescribeLogContext 和 DescribeHistogram)共用一个调用频率和并发限制的额度,具体限制如下:
说明
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
TopicId | String | 是 | 4a******** | 要检索的日志主题 ID。 |
Query | String | 是 |
| 查询语句,语句长度最大为 4KiB。 |
StartTime | Long | 是 | 1346457600000 | 查询开始时间点,精确到毫秒。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 开始计算的毫秒数。如果指定为秒级别,服务端会自动转换精度为毫秒。 |
EndTime | Long | 是 |
| 查询结束时间点,精确到毫秒。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 开始计算的毫秒数。如果指定为秒级别,服务端会自动转换精度为毫秒。 |
Interval | Long | 否 |
| 直方图的子区间长度。单位为毫秒。该值必须大于 1。 说明 直方图中最多可以指定 60 个子区间,请合理规划查询的时间范围及子区间大小。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ResultStatus | String |
| 查询的状态。
|
Interval | Long | 9527 | 直方图的子区间长度。 |
TotalCount | Long | 10000 | 此次请求所有直方图数据总和,即对应时间内符合条件的日志条数。 |
Histogram | Array of HistogramInfo | 所有子区间的结果集。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Time | Integer | 1346457600000 | 子区间的起始时间点,单位为毫秒。UNIX 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的毫秒数。 |
Count | Integer | 1000 | 子区间中对应搜索结果的数量,即该时段内符合条件的日志条数。 |
POST https://tls-{Region}.ivolces.com/DescribeHistogram HTTP/1.1 Content-Type: application/json { "TopicId": "c1***********", "Query": "error", "StartTime": 1662364780730, "EndTime": 1662452983818, "Interval": 1470051 }
{ "Histogram": [ { "Count": 0, "Time": 1662364780730 }, { "Count": 4, "Time": 1662366011922 } ], "Interval": 1470051, "TotalCount": 4, "ResultStatus": "complete" }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidArgument | Invalid argument key %s, value %s, please check argument. | 参数不合法。 |
400 | SqlSyntaxError | Sql syntax Error | SQL格式或语法错误。 |
404 | TopicNotExist | Topic does not exist. | 日志主题不存在。 |
500 | InternalServerError | We encountered an unexpected server error, please try again later. | 服务器内部错误。 |