预警接口文档

1. vo类：WarnInterfaceConfig

属性：
id：数据库的id
appcode：应用编码
uri：预警接口请求uri
successTag：成功标志位
successValue：代表成功的值（强制为String）
successSend：成功是否发送消息（Boolean）
sendTenant：是否发送给租户管理员（Boolea）
name：预警接口名称
code：预警接口编码
messageTag：消息标志位

2. WarnController控制器

预警接口相关方法：

2.1 分页、关键字查询方法

URL： http://ip:port/gwmanage/warn/page/config
method： GET
URL参数：

Key	参数类型	是否必传	备注
pageNo	int	否	页码
pageSize	int	否	每页大小
key	String	否	关键字

成功返回：

{
"status": 1,
"data": {
"hasNext": false,
"hasPre": false,
"itemCount": 1,
"items": [
{
"appcode": "cpu",
"code": "yuncai",
"id": "5a39cd6939f93f16d056402f",
"messageTag": "message",
"name": "云采超市预警接口",
"sendTenant": true,
"successSend": true,
"successTag": "success",
"successValue": "0",
"uri": "/yuncai"
}
],
"pageCount": 1,
"pageIndex": 1,
"pageSize": 10
}
}

返回参数说明

Key	参数类型	是否必传	备注
status	int	是	状态码(1)
data	array	是	返回的查询的预警接口数组

失败返回：

{
"status":0
"msg":"分页查询失败"
}

返回参数说明

Key	参数类型	是否必传	备注
status	int	是	状态码(0)
msg	String	是	失败说明

2.2 保存或更新预警接口

URL： http://ip:port/gwmanage/warn/save/config
method： POST
请求参数：

{
"id":""  (若修改接口参数传id，如添加接口参数不传id)
"appcode":"cpu",
"uri":"/test",
"successTag":"success",
"successValue":0,
"successSend":"true",
"sendTenant":"true",
"name":"测试预警接口",
"code":"test",
"messageTag":"message"
}

返回：

{
"status":1(失败0)
"msg":"保存成功"(失败为"保存失败"+异常信息)
}

返回参数说明

Key	参数类型	是否必传	备注
status	int	是	成功为1，失败为0
msg	String	是	消息

2.3 根据id删除预警接口

URL： http://ip:port/gwmanage/warn/delete/config/{id}
method： POST
请求参数：

Key	参数类型	是否必传	备注
id	String	是	预警接口数据库id

返回：

{
"status":1(失败0)
"msg":"删除成功"(失败为"删除失败"+异常信息)
}

返回参数说明

Key	参数类型	是否必传	备注
status	int	是	成功为1，失败为0
msg	String	是	消息

定时任务相关方法：

2.4 保存定时任务

URL： http://ip:port/gwmanage/warn/save/job
method： POST
请求参数：

{
"tenantId":"p6ochmd2"
"code":"cpu",
"cronexpression":"0 0 3 * * ?",
}

请求参数说明

Key	参数类型	是否必传	备注
tenantId	String	是	租户id
code	String	是	预警接口code
cronexpression	String	是	时间表达式

返回：

{
"status":1
"msg":"新增任务成功"
}

返回参数说明

Key	参数类型	是否必传	备注
status	int	是	状态码，成功为1，失败为0
msg	String	是	消息

2.5 时间表达式检验器

URL： http://ip:port/gwmanage/warn/corn/validate?cronexpression=
method： POST
请求参数：

cronexpression:时间表达式，以key=value的形式接在url后

成功返回：

{
"status":1
"data":"<p>2017-12-26 18:00:00</p><p>2017-12-27 06:00:00</p><p>2017-12-27 12:00:00</p><p>2017-12-27 18:00:00</p><p>2017-12-28 06:00:00</p>"
}

返回参数说明

Key	参数类型	是否必传	备注
status	int	是	状态码，成功为1
data	String	是	最近五次执行时间

失败返回：

{
"status":0
"msg":"时间表达式不正确"
}

返回参数说明

Key	参数类型	是否必传	备注
status	int	是	状态码，失败为0
data	String	是	时间表达式不正确

2.6 分页、关键字查询预警接口相关定时任务方法

URL： http://ip:port/gwmanage/warn/page/job
method： GET
URL参数：

Key	参数类型	是否必传	备注
pageNo	int	否	页码
pageSize	int	否	每页大小
key	String	否	关键字

返回：

{
"status": 1,
"data": {
"itemCount": 1,
"pageIndex": 1,
"pageSize": 10,
"pageCount": 1,
"hasPre": false,
"hasNext": false,
"items": [
{
"id": "5a422e4fcdd51d1e08703d4e",
"dataversion": 0,
"jobname": "p6ochmd2|warninterfacejob",
"aliasname": "预警任务",
"jobgroup": "p6ochmd2",
"jobtrigger": null,
"status": "NORMAL",
"cronexpression": "0 0 3 * * ?",
"issync": false,
"description": "预警任务",
"jobclass": "com.yonyou.nccloud.gwm.service.job.WarnInterfaceJob",
"jobtag": null,
"jobparam": "{ "code": yuncai, "tenantId": "p6ochmd2"}",
"creationtime": 1514286671523,
"modifytime": null,
"lastsuctime": null,
"lastexectime": null,
"lastexecend": null
}
]
}
}

返回参数说明

Key	参数类型	是否必传	备注
status	int	是	状态码(1)
data	array	是	返回的查询的预警接口数组

2.7 删除预警接口定时任务

URL： http://ip:port/gwmanage/warn/delete/job/{id}
method： POST
请求参数：id
返回：

{
"status":1(失败0)
"msg":"删除任务成功"(失败为"删除任务失败"+异常信息)
}

返回参数说明

Key	参数类型	是否必传	备注
status	int	是	成功为1，失败为0
msg	String	是	消息