接口简介 -凯发k8国际|首页

j

api

接口简介

api服务使用http协议,返回数据格式为json格式。当前支持如下查询:

术语

在手册当中使用如下术语:

status code

状态码含义详述
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服务没有处理到的服务端异常;如果出现感谢您能反馈给日志易。
### error code 当返回结果为200但有存在逻辑异常时候,返回的json结果中会有错误码,常见错误码含义如下:
含义详述
1未归类错误未能归类的错误,如出现感谢您反馈给日志易。
42没有权限ak对应的用户没有权限查找对应的数据或功能。
43没有此账户ak对应的用户可能已经被从系统移除。
50日志组不存在请求中source_group参数对应的日志组不存在。
116返回格式错误请检查日志易系统升级时是否有异常导致api服务版本与其他模块不兼容。
201请求错误请检查日志易各模块版本是否存在异常。
501license超出配额license使用量已超出配额,请联系售后支持人员。
502license已过期license已过期,请联系售后支持人员。
520检索超时可能请求的检索范围比较大,查询超时。或者请检查日志易检索模块是否有异常。
521检索请求不合法请参照文档更正检索语句写法。
522检索无结果当前检索请求无结果。
523检索异常请检查日志易检索模块是否有异常。
524没有匹配的索引当前检索无结果。
525没有日志分组的权限请求中source_group对应的日志组无权限。
526检索范围过大可能超出了系统设置的范围,请更改查询条件缩小检索范围。
### 版本 api服务将大版本号放在url路径中,例如第一版的所有请求都是以`/v0`开头: - api第一版搜索时间线接口http path: `/v0/search/timeline`