日志服务
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 日志服务 > API 文档 > 日志相关接口 > 获取日志数量直方图

获取日志数量直方图

最近更新时间：2024-03-12 01:18:07

我的收藏

本页目录：

1. 接口描述

接口请求域名： cls.tencentcloudapi.com 。

本接口用于构建日志数量直方图

默认接口请求频率限制：10000次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeLogHistogram。
Version 是 String 公共参数，本接口取值：2020-10-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
From 是 Integer 要查询的日志的起始时间，Unix时间戳，单位ms
示例值：1608794855000
To 是 Integer 要查询的日志的结束时间，Unix时间戳，单位ms
示例值：1608794855000
Query 是 String 查询语句
示例值：http_status:200
TopicId 否 String 要查询的日志主题ID
示例值：682d0718-07bb-4ec0-9fda-f1e9a2767e0b
Interval 否 Integer 时间间隔: 单位ms 限制性条件：(To-From) / interval <= 200
示例值：10
SyntaxRule 否 Integer 检索语法规则，默认值为0。
0：Lucene语法，1：CQL语法。
详细说明参见检索条件语法规则
示例值：1

3. 输出参数

参数名称 类型 描述
Interval Integer 统计周期： 单位ms
示例值：10
TotalCount Integer 命中关键字的日志总条数
示例值：12
HistogramInfos Array of HistogramInfo 周期内统计结果详情
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取日志分布直方图

根据指定的检索条件，获取符合检索条件的日志分布直方图

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogHistogram
<公共请求参数>

{
    "From": 1685086740862,
    "To": 1685087640862,
    "Interval": 30000,
    "TopicId": "2e7b5c4d-1be3-484a-xxxx-8705adb56dcd",
    "Query": "",
    "SyntaxRule": 1
}

输出示例

{
    "Response": {
        "TotalCount": 14,
        "Interval": 30000,
        "HistogramInfos": [
            {
                "Count": 0,
                "BTime": 1685086740000
            },
            {
                "Count": 0,
                "BTime": 1685086770000
            },
            {
                "Count": 0,
                "BTime": 1685086800000
            },
            {
                "Count": 0,
                "BTime": 1685086830000
            },
            {
                "Count": 0,
                "BTime": 1685086860000
            },
            {
                "Count": 0,
                "BTime": 1685086890000
            },
            {
                "Count": 0,
                "BTime": 1685086920000
            },
            {
                "Count": 0,
                "BTime": 1685086950000
            },
            {
                "Count": 0,
                "BTime": 1685086980000
            },
            {
                "Count": 0,
                "BTime": 1685087010000
            },
            {
                "Count": 0,
                "BTime": 1685087040000
            },
            {
                "Count": 0,
                "BTime": 1685087070000
            },
            {
                "Count": 0,
                "BTime": 1685087100000
            },
            {
                "Count": 0,
                "BTime": 1685087130000
            },
            {
                "Count": 0,
                "BTime": 1685087160000
            },
            {
                "Count": 0,
                "BTime": 1685087190000
            },
            {
                "Count": 0,
                "BTime": 1685087220000
            },
            {
                "Count": 0,
                "BTime": 1685087250000
            },
            {
                "Count": 0,
                "BTime": 1685087280000
            },
            {
                "Count": 0,
                "BTime": 1685087310000
            },
            {
                "Count": 0,
                "BTime": 1685087340000
            },
            {
                "Count": 0,
                "BTime": 1685087370000
            },
            {
                "Count": 0,
                "BTime": 1685087400000
            },
            {
                "Count": 0,
                "BTime": 1685087430000
            },
            {
                "Count": 0,
                "BTime": 1685087460000
            },
            {
                "Count": 0,
                "BTime": 1685087490000
            },
            {
                "Count": 0,
                "BTime": 1685087520000
            },
            {
                "Count": 0,
                "BTime": 1685087550000
            },
            {
                "Count": 0,
                "BTime": 1685087580000
            },
            {
                "Count": 14,
                "BTime": 1685087610000
            },
            {
                "Count": 0,
                "BTime": 1685087640000
            }
        ],
        "RequestId": "4279ae1f-cbd6-438b-xxxx-6df5a8152afd"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
FailedOperation.InvalidContext 检索游标已失效或不存在。
FailedOperation.QueryError 查询语句运行失败。
FailedOperation.SearchTimeout 查询超时。
FailedOperation.SyntaxError 查询语句解析错误。
FailedOperation.TagQpsLimit 请求标签服务限频。
FailedOperation.TopicIsolated 日志主题已隔离。
InternalError 内部错误。
InternalError.SearchError 检索错误
InternalError.SearchFailed 检索失败
InvalidParameter 参数错误。
LimitExceeded.LogSearch 并发查询超过限制，单topic并发最大值15。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。
OperationDenied.NewSyntaxNotSupported 不支持新语法。
ResourceNotFound.TopicNotExist 日志主题不存在。
中国站