DescribeHistogramV1--日志服务-火山引擎

文档中心

立即注册

导航

DescribeHistogramV1

最近更新时间：2024.09.27 16:55:38首次发布时间：2024.09.27 16:55:38

调用 DescribeHistogramV1 接口检索日志，查看满足条件的日志数据随时间分布的情况。

使用说明

此接口用于检索日志，并构建日志检索结果的直方图。
检索相关的接口（SearchLogs、DescribeLogContext 和 DescribeHistogram）共用一个调用频率和并发限制的额度，具体限制如下：

针对单个火山引擎账号或 IAM 用户，日志检索的请求频率限制为 100 次/秒，否则会收到报错 ExceedQPSLimit。
针对单个日志主题，日志检索并发数限制为 15，否则会收到报错 ExceedCountLimit。

说明

检索日志前，请确认已开启了索引。
当查询涉及的日志数量变化非常大时，此接口的可能返回 ResultStatus: incomplete，表示日志服务无法在一次查询中完整扫描指定时段内的所有数据，为了保证查询耗时短，先返回部分查询结果，这个结果可能是不完整的。此时建议缩小检索的时间范围，多次调用该接口执行查询。

请求说明

请求方式：POST
请求地址：https://tls-{Region}.ivolces.com/DescribeHistogramV1

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

参数	类型	是否必选	示例值	描述
EndTime	Long	是	`1630454400000`	查询结束时间点，精确到毫秒。Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 开始计算的毫秒数。如果指定为秒级别，服务端会自动转换精度为毫秒。 EndTime 必须大于 StartTime。
Interval	Long	否	`4733280000`	直方图的子区间长度。单位为毫秒。该值必须大于 1。指定查询的时间范围后，还可以通过 Interval 指定直方图中每个子区间代表的时长，默认通过 60 个子区间展示直方图，即默认情况下 Interval = (EndTime-StartTime)/60，并向上取整。说明直方图中最多可以指定 60 个子区间，请合理规划查询的时间范围及子区间大小。
Query	String	是	`error`	查询语句，语句长度最大为 4KiB。日志服务支持的检索语法请参考检索语法。
StartTime	Long	是	`1346457600000`	查询开始时间点，精确到毫秒。Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 开始计算的毫秒数。如果指定为秒级别，服务端会自动转换精度为毫秒。
TopicId	String	是	`4a9bd4bd-53f1-43ff-b88a-64ee1be5****`	要检索的日志主题 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数类型示例值描述

Histogram Array of HistogramInfoV1 所有子区间的结果集。

参数	类型	示例值	描述
Histogram	Array of HistogramInfoV1		所有子区间的结果集。
ResultStatus	String	`complete`	查询的状态。 complete：查询完成，返回结果完整。 incomplete：查询完成，返回部分结果。 error：查询未完成，返回错误。 time_out：查询超时，返回的结果可能不完整。
TotalCount	Integer	`1000`	此次请求所有直方图数据总和，即对应时间内符合条件的日志条数。

ResultStatus

String

complete

查询的状态。

complete：查询完成，返回结果完整。
incomplete：查询完成，返回部分结果。
error：查询未完成，返回错误。
time_out：查询超时，返回的结果可能不完整。

TotalCount Integer 1000 此次请求所有直方图数据总和，即对应时间内符合条件的日志条数。

HistogramInfoV1

参数	类型	示例值	描述
Count	Long	`1000`	子区间中对应搜索结果的数量，即该时段内符合条件的日志条数。
EndTime	Long	`1630454400000`	查询的结束时间点。
StartTime	Long	`1346457600000`	查询的开始时间点。
ResultStatus	String	`complete`	查询的状态。 complete：查询完成，返回结果完整。 incomplete：查询完成，返回部分结果。 error：查询未完成，返回错误。 time_out：查询超时，返回的结果可能不完整。

请求示例

POST https://tls-{Region}.ivolces.com/DescribeHistogramV1 HTTP/1.1
Content-Type: application/json
{
    "EndTime": 1630454400000,
    "Interval": 4733280000,
    "Query": "error",
    "StartTime": 1346457600000,
    "TopicId": "4a9bd4bd-53f1-43ff-b88a-64ee1be5****"
}

返回示例

Content-Type: application/json; charset=utf-8
{
    "Histogram": [
        {
            "Count": 1000,
            "EndTime": 1630454400000,
            "StartTime": 1346457600000,
            "ResultStatus": "complete"
        }
    ],
    "ResultStatus": "complete",
    "TotalCount": 1000
}

错误码

您可访问公共错误码，获取更多错误码信息。