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

<TCP创建-请求参数>:

参数名称

是否必须

类型

默认值

描述

task_type

string


任务类型

infos

object[]


任务批量信息

infos.task_name

string


任务名称

infos.host

string


任务url

infos.tcp_port

string


端口

partition_flag

string


任务性质,可选值:

  • Intranet:内网

  • External:外网

network_protocol

string


任务使用的网络协议。

 可选值:

  • 4: 使用IPV4协议

  • 6: 使用IPV6协议

  内网任务只能选择4。

group_id

int


监测点分组id。内网使用采集器时id值为0

plugin_task_uselist_id

number[]


采集器id,当是内网任务且分组id为0时,该值为必填参数

frequency

int

监测频率,单位分钟,可选值:1,2,5,10,15,20,30,60

reminds

int

连续告警频率(监控频率的倍数),可选值:0,1,2,3,5,10,20,30

retry

int

重试次数,可选值:1,2,3。只有外网任务支持设置,内网次数默认为1。

history

int

是否记录快照,可选值:

  • 0:不开启

  • 1:开启

all_snapshot

int

是否记录全量快照,可选值:

  • 0:不开启

  • 1:开启

task_scope

object

公开范围

task_scope.type

int

类型,可选值:

  • 1:全部用户

  • 2:指定用户组

  • 3:仅本人

  • 4:指定用户

task_scope.organization

number[]


指定分组id,type=2时使用

task_scope.user

number[]


指定用户id,type=4时使用

threshold_setting

object[]


自定义告警线,告警线各指标详细描述信息可参考<创建任务的自定义告警规则>

threshold_setting.metric

int


告警指标

threshold_setting.cond

string


条件

threshold_setting.value

int


阈值

threshold_setting.unit

string


单位

threshold_setting.advanced_strategy_type

int


高级策略类型

threshold_setting.advanced_status

int


告警策略开关

threshold_setting.status

int


告警线开关

threshold_setting.retry

string


高级策略重试次数

threshold_setting.monitor_set

string


触发的监测点个数类型

  • 1: 任意  

  • 2:指定 

  • 3:平均

threshold_setting.recover_continuous_times

string


高级策略判断恢复的连续次数

threshold_setting.trigger_accumulate_times

string


高级策略判断触发的连续次数

threshold_setting.monitor_count

int


设置触发的任意监测点个数

threshold_setting.type

string


告警线类型,要与任务类型task_type一致。

remind_setting

object


告警通知设置

remind_setting.email

number[]


邮件,item 类型: number

remind_setting.push

string[]


app推送,item 类型: string

remind_setting.remind

number[]


连续提醒,item 类型: number

remind_setting.sms

string[]


短信,item 类型: string

remind_setting.voice

string[]


语音,item 类型: string

remind_setting.wechat

string[]


企业微信,item 类型: string

remind_setting.webhook

number[]


webhook机器人,item 类型: number


<HTTP创建-请求示例>:

curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa" https://v6-api.jiankongbao.com/siteapi/tasks/batch/info  -d '{"task_type":"tcp","infos":[{"task_name":"batch-http-intranet-test-2222","host":"www.163.com","tcp_port":443}],"partition_flag":"Intranet","network_protocol":"4","group_id":0,"plugin_task_uselist_id":[100000176],"frequency":15,"reminds":3,"retry":1,"history":1,"all_snapshot":1,"task_scope":{"type":4,"user":[2670]},"threshold_setting":[{"metric":4,"cond":"12","value":1000,"unit":"","advanced_strategy_type":0,"advanced_status":2,"status":0,"retry":"1","monitor_set":"1","recover_continuous_times":"1","trigger_accumulate_times":"1","monitor_count":3,"type":"tcp"}],"remind_setting":{"email":[2670,25228255],"push":[],"remind":[2670,25228255],"sms":[],"voice":[],"wechat":[],"webhook":[]}}'