更新时间:2025-03-21 GMT+08:00

查询日志直方图

功能介绍

查询关键词搜索条数该接口用于查询日志在某一时间段内,包含关键词的日志上报情况和日志条数统计结果。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1000

最大长度:2000

Content-Type

String

该字段填为:application/json;charset=UTF-8。

最小长度:30

最大长度:30

表3 请求Body参数

参数

是否必选

参数类型

描述

start_time

String

开始时间,毫秒级时间戳

end_time

String

结束时间,毫秒级时间戳

step_interval

Long

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

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

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

说明:

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

group_id

String

日志组ID

最小长度:36

最大长度:36

stream_id

String

日志流ID

最小长度:36

最大长度:36

key_word

String

关键词指相邻两个分词符之间的单词。

is_iterative

Boolean

日志迭代查询,默认为false(不开启迭代),true为开启迭代。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Long

日志条数

histogram

Map<String,HistogramResponseBody>

直方图结果

isQueryComplete

Boolean

是否查询完成

表5 HistogramResponseBody

参数

参数类型

描述

count

Long

日志总条数。

histogram

histogram object

日志直方图。

isQueryComplete

Boolean

是否查询完成。

表6 histogram

参数

参数类型

描述

num

Long

单个时间区间的日志条数。

startTime

String

单个时间区间的开始时间,毫秒级时间戳。

endTime

String

单个时间区间的结束时间,毫秒级时间戳。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

状态码:500

表8 响应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
  } ],
  "isQueryComplete" : true
}

状态码:400

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

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

状态码:500

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

{
  "error_code" : "LTS.0202",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

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

400

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

500

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

错误码

请参见错误码