GetLogs

请求语法

POST /GetLogs HTTP/1.1
Authorization: <AuthorizationString>
x-klog-api-version: 0.1.0
Host: <Project Endpoint>
x-klog-signature-method: hmac-sha1
Date: <GMT Date>
Content-Type: application/json
Content-MD5: <Content-MD5>
Content-Length: <ContentLength>
Connection: Keep-Alive
{
    "ProjectName": "waf_project",
    "LogPoolName": "log_store_20220304164513",
    "From": 1648883076061,
    "To": 1648883976061,
    "Query": "",
    "LogPoolId": "c54011d9-2f88-43e6-94d7-d08a5c16ffd8",
    "HitsOpen": false,
    "Interval": "18s",
    "SortBy":[{"_timestamp_":"desc"}]
}

请求参数

该接口无特有请求头。获取更多信息，请参见公共请求头
参数详情具体如下表。

参数名称	类型	是否必须	描述
ProjectName	String	是	工程名称
LogPoolName	String	是	日志池名称，多个日志池按逗号（,）分隔
From	Int	是	查询开始时间，unix时间戳，单位毫秒
To	Int	是	查询结束时间，unix时间戳，单位毫秒
Query	String	否	查询分析语法。关于查询分析的详细语法，详见查询语法，不填的情况下 返回原始日志
LogPoolId	String	是	日志池id
HitsOpen	Boolean	否	如果需要查询结果展示日志趋势，则需将该字段设为true。默认不会展示日志趋势。
Interval	String	否	间隔。单位支持秒(s)、分(m)、时(h)、天(d)、周(w)。示例：10s、2m、4h、1d、1w。
SortBy	List	否	用于进行结果排序的字段，List<Map<String,String>>，key是需要排序的字段value是排序方式，值为asc或者descValuesKey
Offset	Int	否	表示页数
Size	Int	否	分页大小

响应参数

• 原始日志：如果为查询短语（非SQL），具体返回条数以 line参数为准，如果为SQL查询，原始日志返回10条。
• 聚合日志：如果为SQL查询，需要将聚合结果返回。

参数名称	类型	描述
Total	Int	查询结果总量，如简单短语查询有150w命中，该值为1500000
Count	Int	本次查询返回结果数，如20
HasSql	Boolean	是否为SQL
Logs	List	返回logs
Keys	List	返回所有的字段key
Histogram	List	日志趋势，返回值key是日期时间字符串。如"2021-11-11 11:22:23"；LogCount是当前时间的日志数。
KeyValues	Map	在查询结果里返回对应key的值，Map<String, List

• Log原始日志

参数名称	类型	描述
Key1	String	key1为字段名，值为key1的值
…	…	…
Keyn	String	keyn为字段名，值为keyn的值

错误码

除公共错误码外，还可能返回如下特有错误码：

Http状态码	errorCode	errorMessage
400	InvalidOffsetSize	query offset size can’t be greater than 10000
400	IntervalTooSmall	interval is too small
400	InvalidInterval	check interval when hits open
400	InvalidSQL	can’t parse sql
400	UnKnownException	unknown exception

示例

请求示例

POST /GetLogs HTTP/1.1
Authorization: KLOG <yourAccessKeyId>:<yourSignature>
x-klog-api-version: 0.6.0
Host: klog-cn-beijing-internal.ksyun.com
x-klog-signature-method: hmac-sha1
Date: Sun, 27 May 2018 07:43:26 GMT
Content-Type: application/json
Content-MD5: A7967D81EFF5E3CD447FB6D8DF294E20
Content-Length: 80
Connection: Keep-Alive
{
    "ProjectName": "waf_project",
    "LogPoolName": "log_store_20220304164513",
    "From": 1648883076061,
    "To": 1648883976061,
    "Query": "",
    "LogPoolId": "c54011d9-2f88-43e6-94d7-d08a5c16ffd8",
    "HitsOpen": false,
    "Interval": "18s",
    "SortBy":[{"_timestamp_":"desc"}]
}

响应示例

HTTP/1.1 200
Server: nginx
Content-Length: 0
Connection: close
Access-Control-Allow-Origin: *
Date: Sun, 27 May 2018 07:43:27 GMT
x-klog-requestid: 5B0A619F205DC3F30EDA9322
{
  "Total": 10000,
  "Count" : 1,
  "HasSql": false,
  "Logs": [
    {
        "__timestamp__" : 1650453137138,
        "__source__": "192.168.1.1",
        "Key1": "value1",
        "Key2": "value2"
    }
  ],
  "Keys": ["key3", "key4"]
  "Histogram": [
       {
           "Key": "2021-11-11 11:22:23",
           "LogCount": 3000,
       }
  ],   
  "KeyValues": ["value3", "value4"]
}