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

任务批量操作包括:


任务批量创建

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

<MySQL>:主库

<请求方式>:POST

<请求类型>:JSON

<响应类型>:JSON

<请求参数>:

指标名称

是否必须

数据类型

默认值

描述

task_type

String

目前只支持http、ping、tcp。

task_info_list

array

批量任务信息数组。

数组元素为Object类型,均以”Task“表示,如“Task.task_name”。

Task.task_name

String

任务名称

HTTP/HTTPS任务类型特有字段

Task.url

String

任务目标URL

Task.ip

String

任务目标IP

Task.https_sslv

Int

SSL版本,适用于https监控,可选值:

1: 默认 , 2: TLSv1 , 3: SSLv2 , 4: SSLv3 , 5:TLSv1.0 , 6:TLSv1.1 , 7:   TLSv1.2

选择默认时,顺序适配SSLv3、SSLv2、TLSv1   ssl版本;选择其他选项时,仅适配对应SSL版本。

Task.ssl_verify

Int

是否开启ssl证书认证,可选值:

  • 1-开启

  • 0-关闭 

Task.header

Array

HTTP请求头信息

Ping任务类型特有字段

Task.host

String

Ping任务目标主机

TCP任务类型特有字段

Task.host

String

TCP任务目标主机

Task.tcp_port

Int

TCP任务指定的端口

所有任务类型的公共参数

Task.network_protocol

String

可选值:

  • 4: 使用IPV4协议(支持的任务类型:http、ping 、tcp)

  • 6:使用IPV6协议支持的任务类型:http、ping)

  • auto:自动匹配(支持的任务类型:http)

Task.group_id

Int

监测点分组ID

请按照Task.network_protocol来选择监测点分组。

Task.frequency

Int

任务监控频率

Task.reminds

Int

0

连续提醒范围 0,1, 2, 3, 5, 10, 20, 30

Task.retry

Int

1

重试次数范围1~3

Task.history

Int

0

是否记录快照,可选值:

  • 0-关闭

  • 1-开启

Task.all_snapshot

Int

0

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

  • 0-关闭

  • 1-开启

Task.threshold_setting

Array

任务告警线数组(规则参考“创建任务的自定义告警规则”)

Task.task_scope

object

项目公开范围

Task.task_scope.type

Int

公开范围:

1:所有所在企业用户 2:用户组

3: 仅限本人 4:部分企业用户

Task.task_scope.organization

Array


设定的用户组ID

设置不同公开范围,此字段值不同:

如果设置公开范围为2时,值应为所选的用户组ID数组。

设置公开范围为其他,值应为空数组或者缺省。

Task.task_scope.user

Array


设定的用户ID

设置不同公开范围,此字段值不同:

如果设置公开范围为3,4时,值应为所选的用户ID数组。(设置公开范围为3时,值应为只包含当前用户的ID数组)

设置公开范围为其他,值应为空数组或者缺省。

Task.remind_setting

object

常规告警通知设置

"email","sms",voice","push","wechat"为

指定需要以该告警通知方式通知的人员ID数组。

"remind"为指定需要连续告警通知的人员ID数组。

 <请求示例>:

curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa"  https://v6-api.jiankongbao.com/siteapi/tasks/batch -d '{"task_type":"http","task_info_list":[{"task_name":"ssss","url":"http://dsdasd.com","ip":"","https_sslv":"0","ssl_verify":"","frequency":2,"reminds":1,"retry":1,"all_snapshot":0,"history":1,"task_scope":{"type":1},"header":[],"group_id":0,"threshold_setting":[{"metric":1,"cond":1,"type":"http","value":2,"unit":1,"status":0,"retry":1, "monitor_set":1,"monitor_count":3,"advanced_status":2 }],"remind_setting":{"email":[],"sms":[],"voice":[],"push":[],"wechat":[],"remind":[]}}]}'

<响应数据>:

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

参数名称

数据类型

描述

order

Int

返回数据的顺序

task_id

Int

新增的任务ID(创建失败该字段返回值为空字符)

task_name

String

任务名称

task_result

String

处理结果

msg

String

提示消息

 <响应示例>:

[
    {
        "order":"1",
        "task_name":"oppo_1",
        "task_result":"success",
        "msg":"创建成功",
        "task_id":"12323"
    },
    {
        "order":"2",
        "task_name":"oppo_2",
        "task_result":"fail",
        "msg":"创建失败",
        "task_id":""
    }
]

任务批量删除

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

<MySQL>:主库

<请求方式>:DELETE

<请求类型>:JSON

<响应类型>:JSON

<请求参数>:

指标名称

是否必须

数据类型

默认值

描述

task_ids

Array

需要批量删除的任务ID数组。

 <请求示例>:

curl -X DELETE -H "token:a3af84f7c1d0d935024ba58b5da78aaa" https://v6-api.jiankongbao.com/siteapi/tasks/batch -d '{"task_ids":[6925392,6925393]}'

<响应数据>:

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

参数名称

数据类型

描述

order

Int

返回数据的顺序

task_id

Int

已处理的任务ID

task_name

String

任务名称

task_result

String

处理结果

msg

String

提示消息

<响应示例>:

[
    {
        "order": 1,
        "task_name": "batch_del_2",
        "task_result": "success",
        "msg": "删除成功",
        "task_id": "6925393"
    },
    {
        "order": 2,
        "task_name": "batch_del_1",
        "task_result": "success",
        "msg": "删除成功",
        "task_id": "6925392"
    }
]