接口说明
日志查询接口
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST/paasopenapi/api/cmplogadmin/cmplog/mgr/logSearch/logstoreindex/getLogs.jsonHTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|---|
appName | string | body | 否 | xxx | 应用名称 |
from | integer | body | 否 | 1692265528000 | 日志时间查询开始时间[毫秒] |
logProjectId | integer | body | 是 | xxx | 日志项目id -必填 |
logRuleIdList | array | body | 否 | xxx | 日志规则id -非必填,为空或者Null表示搜索全部 |
logUnitIdList | array | body | 否 | xxx | 日志单元id -非必填,为空或者Null表示搜索全部 |
pageNum | integer | body | 否 | 1 | 起始页,不传默认1 |
pageSize | integer | body | 否 | 10 | 每页大小,不传默认10 |
query | array | body | 否 | china |
检索条件 |
queryModel | string | body | 否 | 1 | 检索模式: 1-快捷模式; 2-交互模式 |
resPoolCode | string | body | 否 | dbxxxxx | 资源池编码 |
to | integer | body | 否 | 1692265548000 | 日志时间查询结束时间[毫秒] |
返回数据
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | Integer | 0 | 返回状态码,成功:0;失败:非0 |
data | Object | ||
msg | string | success | 返回描述 |
data数据结构:
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
logResult | Object | 日志内容集合 |
logResult数据结构:
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
total | Integer | 日志总量 | |
hits | Array | 日志体 |
hits数据结构:
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
content | String | 日志正文 | |
json | Map | {"date": "2022"} | 日志的解析字段 |
ruleId | Integer | 1 | 日志规则id |
time | Long | 16562353542 | 日志时间戳,毫秒 |
示例
请求示例
POST/paasopenapi/api/cmplogadmin/cmplog/mgr/logSearch/logstoreindex/getLogs.jsonHTTP/1.1
Content-Type:application/json
{
"appName":"",
"from":0,
"logProjectId":0,
"logRuleIdList":[],
"logUnitIdList":[],
"pageNum":0,
"pageSize":0,
"query":[
{
"inputValue":[],
"keyName":"",
"modeValue":"",
"mutiValueConnector":"",
"num":0,
"reverseFlag":"",
"targetParamType":"",
"value":""
}
],
"queryModel":"",
"resPoolCode":"",
"ruleName":"",
"searchDuration":0,
"searchDurationUnit":"",
"to":0
}
正常返回示例
JSON格式
HTTP/1.1200OK
{
"code":0,
"msg":"string",
"data":{"logResult":{
"hits":{
"hits":[
{
"json":{
"host.ip":"198.18.64.135",
"fileName":"/app/cams/log-agent/logs/log-agent.log",
"host.uuid":"6accb90e-5690-4bd9-9953-f2bf2979538b",
"message":"{\"level\":\"info\",\"time\":\"2023-08-22T17:23:57\",\"caller\":\"D:/GolandProjects/ctyun-log/log_agent/pipeline/input/persis/offsetPersis.go:154\",\"message\":\"writeoffsetintofile.\\\\file.offset.\"}"
},
"time":1692696246437,
"ruleId":6180,
"content":"{\"level\":\"info\",\"time\":\"2023-08-22T17:23:57\",\"caller\":\"D:/GolandProjects/ctyun-log/log_agent/pipeline/input/persis/offsetPersis.go:154\",\"message\":\"writeoffsetintofile.\\\\file.offset.\"}"
}
]
}
}
}
}
错误码
HTTP状态码(Status Code) | 错误码(Error Code) | 描述(Description) |
---|---|---|
400 | MissingParameter | 缺少必要的请求参数。 |
500 | FailedOperation | 操作失败 |