tencent cloud

日志服务

动态与公告
产品动态
公告
新手指引
产品简介
产品概述
产品优势
地域和访问域名
规格与限制
基本概念
购买指南
计费概述
产品定价
按量计费(后付费)
欠费说明
清理日志服务资源
成本优化
常见问题
快速入门
一分钟入门指南
入门指南
使用 Demo 日志快速体验 CLS
操作指南
资源管理
权限管理
日志采集
指标采集
日志存储
指标存储
检索分析(日志主题)
检索分析(指标主题)
仪表盘
数据处理
投递与消费
监控告警
云产品中心
DataSight 独立控制台
历史文档
实践教程
日志采集
检索分析
仪表盘
监控告警
投递和消费
成本优化
开发者指南
通过 iframe 内嵌 CLS(旧方案)
通过 Grafana 使用 CLS
API 文档
History
Introduction
API Category
Making API Requests
Topic Management APIs
Log Set Management APIs
Index APIs
Topic Partition APIs
Machine Group APIs
Collection Configuration APIs
Log APIs
Metric APIs
Alarm Policy APIs
Data Processing APIs
Kafka Protocol Consumption APIs
CKafka Shipping Task APIs
Kafka Data Subscription APIs
COS Shipping Task APIs
SCF Delivery Task APIs
Scheduled SQL Analysis APIs
COS Data Import Task APIs
Data Types
Error Codes
常见问题
健康监测问题解释
采集相关
检索分析相关
其他问题
服务等级协议
CLS 政策
隐私协议
数据处理和安全协议
联系我们
词汇表

DescribeLogHistogram

PDF
聚焦模式
字号
最后更新时间: 2025-11-13 20:47:15

1. API Description

Domain name for API request: cls.intl.tencentcloudapi.com.

This API is used to get a log count histogram.

A maximum of 10000 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeLogHistogram.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region No String Common Params. This parameter is not required for this API.
From Yes Integer Start time of the log to be queried, which is a Unix timestamp in milliseconds
To Yes Integer End time of the log to be queried, which is a Unix timestamp in milliseconds
Query Yes String Query statement
TopicId No String ID of the log topic to be queried
Interval No Integer Interval in milliseconds. Condition: (To-From) / Interval <= 200
SyntaxRule No Integer Search syntax. Valid values:
0 (default): Lucene; 1: CQL
For more information, see Search Syntax.

3. Output Parameters

Parameter Name Type Description
Interval Integer Statistical period in milliseconds
TotalCount Integer The number of logs that hit the keywords
HistogramInfos Array of HistogramInfo Statistical result details within the period
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Getting a Log Count Histogram

This example shows you how to get a log count histogram by specified conditions.

Input Example

POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogHistogram
<Common request parameters>

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

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.InvalidContext The search cursor is invalid or does not exist.
FailedOperation.QueryError The query statement failed to run.
FailedOperation.SearchTimeout The query timed out.
FailedOperation.SyntaxError An error occurred while parsing the query statement.
FailedOperation.TagQpsLimit The frequency of tag service requests is limited.
FailedOperation.TopicIsolated The log topic has been isolated.
InternalError Internal error.
InternalError.SearchError Retrieval error
InternalError.SearchFailed Retrieval failed
InvalidParameter Incorrect parameter.
LimitExceeded.LogSearch The number of concurrent queries exceeds the limit, which is 15 per topic.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.AccountDestroy The account has been terminated.
OperationDenied.AccountIsolate The account has overdue payments.
OperationDenied.AccountNotExists The account does not exist.
OperationDenied.NewSyntaxNotSupported New syntax is not supported.
ResourceNotFound.TopicNotExist The log topic does not exist.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈