维护窗口API包括:
创建维护窗口
<接口地址>:/siteapi/tasks/maintain
<请求方式>:POST
<请求类型>:JSON
<响应类型>:JSON
<请求参数>:
指标名称 | 是否必须 | 数据类型 | 默认值 | 描述 |
mw_title | 是 | String | 无 | 维护窗口标题 |
mw_dscpt | 否 | String | 空 | 维护窗口描述 |
mw_task_comp | 否 | Array | 空 | 指定维护窗口的生效的任务id |
repeat_type | 是 | Int | 无 | 维护窗口类型.0: 固定时间;1: 按天重复;2: 按周重复 |
start_date | 是 | String | 无 | 维护窗口生效起始时间 |
duration | 是 | Int | 无 | 持续时间,单位小时 |
duration_m | 是 | Int | 无 | 持续时间,单位分钟 |
end_date | 否 | String | 无 | 维护窗口结束时间,当repeat_type为1或2时要指定 |
selected_week | 否 | Array | 无 | 维护窗口指定周几生效,当repeat_type为2时要指定。 1:周一,2:周二,3:周三,4:周四,5:五,6:周六,7:周日 |
<请求示例>:
curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa" https://v6-api.jiankongbao.com/siteapi/tasks/maintain -d '{"mw_title":"测试","mw_dscpt":"这是描述信息dddd11","repeat_type":2,"start_date":"2019-09-10 15:40:00","duration":1,"duration_m":10,"mw_task_comp":[],"end_date":"2019-9-30 00:00","selected_week":["7","6","1"]}
<响应数据>:
参数名称 | 数据类型 | 描述 |
mw_id | Int | 维护窗口id |
<响应示例>:
{"mw_id":"252"}
<接口地址>:/siteapi/tasks/maintain
<请求方式>:PUT
<请求类型>:JSON
<响应类型>:JSON
<请求参数>:
指标名称 | 是否必须 | 数据类型 | 默认值 | 描述 |
mw_id | 是 | Int | 无 | 维护窗口id |
mw_title | 是 | String | 无 | 维护窗口标题 |
mw_dscpt | 否 | String | 空 | 维护窗口描述 |
mw_task_comp | 否 | Array | 空 | 指定维护窗口的生效的任务id |
repeat_type | 是 | Int | 无 | 维护窗口类型.0: 固定时间;1: 按天重复;2: 按周重复 |
start_date | 是 | String | 无 | 维护窗口生效起始时间 |
duration | 是 | Int | 无 | 持续时间,单位小时 |
duration_m | 是 | Int | 无 | 持续时间,单位分钟 |
end_date | 否 | String | 无 | 维护窗口结束时间,当repeat_type为1或2时要指定 |
selected_week | 否 | Array | 无 | 维护窗口指定周几生效,当repeat_type为2时要指定。 1:周一,2:周二,3:周三,4:周四,5:五,6:周六,7:周日 |
<请求示例>:
curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa" https://v6-api.jiankongbao.com/siteapi/tasks/maintain -d '{"mw_title":"测试","mw_dscpt":"这是描述信息dddd11","repeat_type":2,"start_date":"2019-09-10 15:40:00",”mw_id”:252,"duration":1,"duration_m":10,"mw_task_comp":[],"end_date":"2019-9-30 00:00","selected_week":["7","6","1"]} '
<响应数据>:
参数名称 | 数据类型 | 描述 |
mw_id | Int | 维护窗口id |
<响应示例>:
{"mw_id":"252"}
<接口地址>:/siteapi/tasks/maintain
<请求方式>:GET
<请求类型>:JSON
<响应类型>:JSON
<请求参数>:无
<请求示例>:
curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa" https://v6-api.jiankongbao.com/siteapi/tasks/maintain
<响应数据>:
根数据节点为数组,数组元素包含以下字段。
指标名称 | 数据类型 | 描述 |
mw_id | string | 维护窗口id |
mw_title | String | 维护窗口标题 |
mw_dscpt | String | 维护窗口描述 |
tasks | Int | 维护窗口指定了的任务数 |
repeat_freq | string | 维护窗口类型.0: 固定时间;1: 按天重复;2: 按周重复 |
s_date | String | 维护窗口生效起始日期 |
s_time | String | 维护窗口生效起始时间 |
duration | string | 持续时间,单位分钟 |
e_date | String | 维护窗口结束日期 |
e_time | String | 维护窗口结束时间 |
crt_time | String | 维护窗口创建时间 |
usr_id | string | 创建者id |
is_repeat | string | 是否重复,1是,0否 |
mw_status | string | 维护窗口状态,1打开,0关闭 |
<响应示例>:
[ { "mw_id":"184", "usr_id":"2670", "mw_title":"测试", "is_repeat":"1", "repeat_freq":"1", "freq_day":"", "s_date":"2019-09-23", "e_date":"2019-09-29", "s_time":"18:40:00", "e_time":"", "duration":"70", "mw_dscpt":"这是描述信息11", "crt_time":"1492765294", "mw_status":"1", "tasks":14 }, { "mw_id":"251", "usr_id":"2671", "mw_title":"111", "is_repeat":"0", "repeat_freq":"0", "freq_day":"", "s_date":"2019-09-27", "e_date":"", "s_time":"23:59", "e_time":null, "duration":"61", "mw_dscpt":"11", "crt_time":"1569551464", "mw_status":"1", "tasks":1 } ]
<接口地址>:/siteapi/tasks/maintain
<请求方式>:DELETE
<请求类型>:JSON
<响应类型>:JSON
<请求参数>:
指标名称 | 是否必须 | 数据类型 | 默认值 | 描述 |
mw_id | 是 | Int | 无 | 维护窗口id |
<请求示例>:
curl -X DELETE -H "token:a3af84f7c1d0d935024ba58b5da78aaa" https://v6-api.jiankongbao.com/siteapi/tasks/maintain -d '{"mw_id ": 252}'
<响应数据>:
参数名称 | 数据类型 | 描述 |
mw_id | String | 维护窗口id |
<响应示例>:
{"mw_id":"252"}