更新时间:2025-08-20 GMT+08:00

查询日志直方图

功能介绍

查询关键词搜索条数。通过该接口可以在指定的时间段内,对日志进行查询和统计。不仅能够准确统计包含该关键词的日志条数,还能详细展示每条日志的上报情况。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/lts/keyword-count

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参见:获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

用于定义消息体的格式,该字段填为:application/json;charset=utf8。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

start_time

String

参数解释:

按照时间范围搜索日志的起始时间。日志时间为日志数据写入时的时间。

参数start_time和end_time组成的时间区间,既包含起始时间也包含结束时间。

约束限制:

  • 查询时间区间最大为180天。

  • start_time和end_time取值不能相同。

取值范围:

毫秒级时间戳,表示从1970-1-1 00:00:00 UTC开始计算的毫秒数。

默认取值:

不涉及。

end_time

String

参数解释:

按照时间范围搜索日志的结束时间。日志时间为日志数据写入时的时间。

参数start_time和end_time组成的时间区间,既包含起始时间也包含结束时间。

约束限制:

  • 查询时间区间最大为180天。

  • start_time和end_time取值不能相同。

取值范围:

毫秒级时间戳,表示从1970-1-1 00:00:00 UTC开始计算的毫秒数。

默认取值:

不涉及。

step_interval

Long

参数解释:

时间步长,单位为毫秒(ms)。

具体请参考如下公式计算:

(end_time-start_time) / 1000 * 1000 / 60,其中 / 1000 * 1000 / 表示取整。

约束限制:

如果计算出的时间步长小于等于1000时,则时间步长为1000。

取值范围:

最小值:1000

默认取值:

不涉及。

group_id

String

参数解释:

日志组ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

stream_id

String

参数解释:

日志流ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

key_word

String

参数解释:

支持关键词精确搜索。关键词指相邻两个分词符之间的单词。例如:error。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

is_iterative

Boolean

参数解释:

表示是否开启日志迭代查询功能。

约束限制:

不涉及。

取值范围:

  • true:开启迭代查询。日志查询结果按迭代分批返回,适合日志数据量大的场景。

  • false:不开启迭代查询。日志查询结果一次性返回,适合日志数据量小的场景。

默认取值:

false

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Long

参数解释:

日志条数。

取值范围:

不涉及。

histogram

String

参数解释:

直方图结果。

取值范围:

不涉及。

isQueryComplete

Boolean

参数解释:

是否查询完成。

取值范围:

  • true:查询完成。

  • false:未查询完成。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

error_msg

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

error_msg

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

请求示例

查询日志直方图。

POST https://{endpoint}/v2/{project_id}/lts/keyword-count

{
  "group_id" : "00330565-5baf-4e0d-bd16-ba0c6b951d9a",
  "stream_id" : "715cda3b-e17f-492a-a6ca-98a1ba16ad8c",
  "end_time" : 1637820813605,
  "start_time" : 1637817213605,
  "key_word" : "test",
  "step_interval" : 6000
}

响应示例

状态码:200

查询直方图数据请求响应成功。

{
  "count" : 1,
  "histogram" : [ {
    "num" : 1,
    "startTime" : 1637821594579,
    "endTime" : 1637821595000
  }, {
    "num" : 0,
    "startTime" : 1637821654000,
    "endTime" : 1637821654579
  } ]
}

状态码:400

非法请求,建议根据error_msg直接修改该请求。

{
  "error_code" : "LTS.0601",
  "error_msg" : "must be less than or equal to 86400000"
}

SDK代码示例

SDK代码示例如下。

查询日志直方图。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;


public class ListLogHistogramSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListLogHistogramRequest request = new ListLogHistogramRequest();
        QueryLogKeyWordCountRequestBody body = new QueryLogKeyWordCountRequestBody();
        body.withKeyWord("test");
        body.withStreamId("715cda3b-e17f-492a-a6ca-98a1ba16ad8c");
        body.withGroupId("00330565-5baf-4e0d-bd16-ba0c6b951d9a");
        body.withStepInterval(6000L);
        body.withEndTime("1637820813605");
        body.withStartTime("1637817213605");
        request.withBody(body);
        try {
            ListLogHistogramResponse response = client.listLogHistogram(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

查询日志直方图。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListLogHistogramRequest()
        request.body = QueryLogKeyWordCountRequestBody(
            key_word="test",
            stream_id="715cda3b-e17f-492a-a6ca-98a1ba16ad8c",
            group_id="00330565-5baf-4e0d-bd16-ba0c6b951d9a",
            step_interval=6000,
            end_time="1637820813605",
            start_time="1637817213605"
        )
        response = client.list_log_histogram(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

查询日志直方图。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListLogHistogramRequest{}
	request.Body = &model.QueryLogKeyWordCountRequestBody{
		KeyWord: "test",
		StreamId: "715cda3b-e17f-492a-a6ca-98a1ba16ad8c",
		GroupId: "00330565-5baf-4e0d-bd16-ba0c6b951d9a",
		StepInterval: int64(6000),
		EndTime: "1637820813605",
		StartTime: "1637817213605",
	}
	response, err := client.ListLogHistogram(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询直方图数据请求响应成功。

400

非法请求,建议根据error_msg直接修改该请求。

500

表明服务端能被请求访问到,但是服务内部出错。

错误码

请参见错误码