接口规范说明
接口前提参数规则
开放api接口域名
接口响应状态码与错误码说明
基础信息描述
基础信息
获取访问开放api的token
地区基础信息
运营商基础信息
用户可以使用的监测点列表
获取任务正在使用的监测点信息
任务管理
基础信息
任务创建
任务修改
任务删除
任务详情
任务开启
任务暂停
任务列表
任务批量操作
维护窗口
告警管理
创建任务的自定义告警规则
修改任务的自定义告警规则
删除任务的自定义告警规则
查看任务的自定义告警规则
创建任务告警通知
修改任务告警通知
获取任务告警通知
删除任务告警通知
历史快照数据
查看历史快照列表
查看单次历史快照详情
查看单次快照中的响应结果
任务故障
任务所有监测点的故障记录
任务单个监测点故障记录
任务单个监测点故障次数
批量任务故障记录
告警消息
消息列表
单条消息详情
单条消息通知详情
响应时间与可用率
任务所有监测点的统计汇总数据
任务平均响应时间刻度数据
任务平均响应时间详细统计刻度数据
任务平均可用率刻度数据
traceroute任务跳数统计刻度数据
获取任务最近一次监测结果数据
监测点分组管理
账号监测点分组列表
获取监测点分组信息
修改监测点分组信息
添加监测点分组信息
删除监测点分组信息
用户管理
获取用户基本信息
修改用户基本信息
创建用户
删除用户
当前账户信息
获取当前账户信息
账号公共设置
获取当前账户下用户列表
获取当前账户套餐信息
用户分组管理
用户分组列表
添加用户分组
修改用户分组
删除用户分组
获取单个分组下的用户
获取多个分组下的用户
将用户添加入分组
附录
附录一 siteapi错误编码与含义
附录二 userapi错误编码与含义

维护窗口API包括:


创建维护窗口

<接口地址>:/siteapi/tasks/maintain

<MySQL>:主库

<请求方式>: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

<MySQL>:主库

<请求方式>: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

<MySQL>:主库

<请求方式>:GET

<请求类型>:JSON

<响应类型>:JSON

<请求参数>:无

 <请求示例>:

curl   -H "token:a3af84f7c1d0d935024ba58b5da78aaa" https://v6-api.jiankongbao.com/siteapi/tasks/maintain

<响应数据>:

根数据节点为数组,数组元素包含以下字段。

指标名称

数据类型

描述

mw_id

Int

维护窗口id

mw_title

String

维护窗口标题

mw_dscpt

String

维护窗口描述

tasks

Int

维护窗口指定了的任务数

repeat_freq

Int

维护窗口类型.0: 固定时间;1: 按天重复;2: 按周重复

s_date

String

维护窗口生效起始日期

s_time

String

维护窗口生效起始时间

duration

Int

持续时间,单位分钟

e_date

String

维护窗口结束日期

e_time

String

维护窗口结束时间

crt_time

String

维护窗口创建时间

 <响应示例>:

[    
{        
"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

<MySQL>:主库

<请求方式>: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

Int

维护窗口id

<响应示例>:

{"mw_id":"252"}