接口简介
API服务使用HTTP协议,返回数据格式为JSON格式。当前支持如下查询:
术语
在手册当中使用如下术语:
- event(事件):一条被收录在日志易系统中的日志称为一个事件(event)
Status Code
<table border cellspacing=0 cellpadding=10 >
状态码 | 含义 | 详述 |
</thead>
200 | 成功 | 请求成功执行。 |
400 | 用户请求内容错误 | 可能请求的参数缺少qt,ak,sign;可能使用了错误的ak;可能请求URL没有encode。 |
403 | 用户没有权限访问该资源 | 可能是计算错了签名sign;可能这是一次重复的请求被认为是replay attack。 |
404 | 找不到请求的资源 | 可能是路径错误如/events写为了/event;可能是传入了不支持的参数或者参数给定了非法的值,比如传入了order=''但值不为desc和asc。 |
405 | 不支持此方法 | GET接口却使用了POST等类似情况。 |
408 | 用户请求过期 | 可能是qt参数标明的时间戳为服务器时间的一分钟之前,考虑需要同步客户端与服务端时间。 |
500 | 服务端错误 | API服务没有处理到的服务端异常;如果出现感谢您能反馈给日志易。 |
</table>
### Error Code
当返回结果为200但有存在逻辑异常时候,返回的json结果中会有错误码,常见错误码含义如下:
<table border cellspacing=0 cellpadding=10 >
| 含义 | 详述 |
</thead>
1 | 未归类错误 | 未能归类的错误,如出现感谢您反馈给日志易。 |
42 | 没有权限 | ak对应的用户没有权限查找对应的数据或功能。 |
43 | 没有此账户 | ak对应的用户可能已经被从系统移除。 |
50 | 日志组不存在 | 请求中source_group参数对应的日志组不存在。 |
116 | 返回格式错误 | 请检查日志易系统升级时是否有异常导致API服务版本与其他模块不兼容。 |
201 | 请求错误 | 请检查日志易各模块版本是否存在异常。 |
501 | license超出配额 | license使用量已超出配额,请联系售后支持人员。 |
502 | license已过期 | license已过期,请联系售后支持人员。 |
520 | 检索超时 | 可能请求的检索范围比较大,查询超时。或者请检查日志易检索模块是否有异常。 |
521 | 检索请求不合法 | 请参照文档更正检索语句写法。 |
522 | 检索无结果 | 当前检索请求无结果。 |
523 | 检索异常 | 请检查日志易检索模块是否有异常。 |
524 | 没有匹配的索引 | 当前检索无结果。 |
525 | 没有日志分组的权限 | 请求中source_group对应的日志组无权限。 |
526 | 检索范围过大 | 可能超出了系统设置的范围,请更改查询条件缩小检索范围。 |
</table>
### 版本
API服务将大版本号放在url路径中,例如第一版的所有请求都是以`/v0`开头:
- API第一版搜索时间线接口HTTP path: `/v0/search/timeline`