docs(install): more api explain

This commit is contained in:
lxd1190 2018-11-01 22:24:37 +08:00
parent 993418dc58
commit e831610019

View File

@ -9,7 +9,7 @@
- API请求调用请使用搭建的后端服务地址
- 当前检测时间窗口选取为3小时每分钟1个数据点即窗口值为180
- 同比数据日期和时间段的选择可根据实际情况调整,文档中两个同比数据分别昨日和一周前的同比
- 同比数据日期和时间段的选择可根据实际情况调整,文档中两个同比数据分别昨日和一周前的同比
针对当前一个值的检测,需要依赖过去三段数据,数据选取规则参考示例图:
![data_info](images/data_info.png)
@ -45,10 +45,10 @@
| attrName| string| 是| 无|指标名称|
| taskId| string| 否| 无|使用的检测模型,如不传,则采用系统默认模型|
| window| int| 是| 无|窗口值目前支持180|
| time| string| 是| 无|待检测点的时间标识 即dataA的最后一个点格式"yyyy-MM-dd HH:mm:ss"|
| dataC| string| 是| 无|待检测的1个点对应一周前同时刻的点 + 前后小时的数据361个数据点按时间顺序拼接英文逗号分隔|
| dataB| string| 是| 无|待检测的1个点对应昨日同时刻的点 + 前后三小时的数据361个数据点按时间顺序拼接英文逗号分隔|
| dataA| string| 是| 无|待检测的1个点+前三小时的数据共181个数据点181个数据点按时间顺序拼接英文逗号分隔|
| time| string| 是| 无|待检测点的时间标识即dataA的最后一个点格式"yyyy-MM-dd HH:mm:ss"|
| dataC| string| 是| 无|待检测的1个点对应一周前同时刻的点 + 前后各180个数据361个数据点按时间顺序拼接英文逗号分隔|
| dataB| string| 是| 无|待检测的1个点对应昨日同时刻的点 + 前后各180个数据361个数据点按时间顺序拼接英文逗号分隔|
| dataA| string| 是| 无|待检测的1个点+前180个数据共181个数据点181个数据点按时间顺序拼接英文逗号分隔|
* 详情参数response
@ -71,7 +71,7 @@
| code | int | 返回码。0:成功非0:失败 |
| msg | string | 返回消息 |
| ret | int | 检测结果是否异常。0:异常1:正常 |
| p | string | 概率值值越小置信度越高目前p<0.15判决为异常 |
| p | string | 概率值,值越小,判定为异常的置信度越高目前p<0.15判决为异常 |
### 2、率值检测
@ -102,10 +102,10 @@
| attrId| string| 是| 无|指标ID|
| attrName| string| 是| 无|指标名称|
| window| int| 是| 无|窗口值目前支持180|
| time| string| 是| 无|待检测点的时间标识 即dataA的最后一个点格式"yyyy-MM-dd HH:mm:ss"|
| dataC| string| 是| 无|待检测的1个点对应一周前同时刻的点 + 前后小时的数据361个数据点按时间顺序拼接英文逗号分隔|
| dataB| string| 是| 无|待检测的1个点对应昨日同时刻的点 + 前后三小时的数据361个数据点按时间顺序拼接英文逗号分隔|
| dataA| string| 是| 无|待检测的1个点+前三小时的数据共181个数据点181个数据点按时间顺序拼接英文逗号分隔|
| time| string| 是| 无|待检测点的时间标识即dataA的最后一个点格式"yyyy-MM-dd HH:mm:ss"|
| dataC| string| 是| 无|待检测的1个点对应一周前同时刻的点 + 前后各180个数据361个数据点按时间顺序拼接英文逗号分隔|
| dataB| string| 是| 无|待检测的1个点对应昨日同时刻的点 + 前后各180个数据361个数据点按时间顺序拼接英文逗号分隔|
| dataA| string| 是| 无|待检测的1个点+前180个数据共181个数据点181个数据点按时间顺序拼接英文逗号分隔|
* 详情参数response
@ -129,4 +129,4 @@
| code | int | 返回码。0:成功非0:失败 |
| msg | string | 返回消息 |
| ret | int | 检测结果是否异常。0:异常1:正常 |
| p | string | 概率值,值越小,置信度越高 |
| p | string | 概率值,值越小,判定为异常的置信度越高 |