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

<TRACEROUTE创建-请求参数>:

参数名称

是否必须

类型

默认值

描述

task_name

string


任务名称

task_type

string


任务类型

frequency

int


监控频率

retry

int

1

重试次数范围1~3 默认为1

 network_protocol 否 string 4

 任务使用的网络协议。

 可选值:

  • 4: 使用IPV4协议

group_id

int


监测点分组

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

history

int

0

记录节点故障快照(0:不记录;1:记录)

reminds

int

0

连续告警提醒

open_scope

int

1

项目公开范围1-4

organization

array


公开范围分组列表,当公开范围为2是必填

user_ids

array


公开范围用户列表,当公开范围为4是必填

host

string


域名

 

<TRACEROUTE创建-请求示例>:

curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa" https://v6-api.jiankongbao.com/siteapi/tasks/task  -d '{"task_name": "tiger_traceroute2","task_type": "traceroute","frequency": 2,"retry": 3,"group_id": 1,"history": 1,"reminds": 20,"host": "www.tiger.com"}'