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

WebSocket响应数据:

参数名称

数据类型

描述

task_id

string

任务id

frequency

string

监控频率(分钟)(2,5,10,15,20,30,60)

retry

string

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

network_protocol

string

任务使用的网络协议。 可选值:4: 使用IPV4协议6: 使用IPV6协议

group_id

string

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

all_snapshot

string

是否记录所有频率快照(0:不记录,1:记录)

is_remind

string

告警通知连续提醒(0/1)

organization

list[int]

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

user_ids

list[int]

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

user_ids_info

list

公开范围用户信息列表

url

string

url地址(ws://xxx|wss://xxx)

cookies

string

cookies信息

header

string

HTTP请求头信息

header.key

string

HTTP请求头信息Key

header.value

string

HTTP请求头信息Value

receive_wait_time

string

接收sokect响应内容超时时间,单位为秒(s)  可选值:5/10/15/20

https_sslv

string

ssl版本,适用于wss监控(选择默认时,顺序适配TLSv1.2 ssl版本;选择其他选项时,仅适配对应ssl版本),0- 默认 4- TLSv1.0 5- TLSv1.1 6- TLSv1.2

ssl_verify

string

是否开启ssl证书认证 1开启0关闭

send_content

string

向sokect发送内容

pattern_str

string

匹配内容

pattern_header

list

匹配header的时候header,支持多个

pattern_header.type

int

可选枚举值(3,等于,4包含,6不包含)         (所有枚举值:1不为空、2为空、3等于、4不等于、5包含、6不包含,给以后升级开的口子 )

pattern_header.value

string

匹配header的时候header_value ,支持多个

pattern_header.key

string

匹配header的时候header_key,支持多个

task_user_id

string

任务创建用户编号

alert_freq

string

告警频率[0-无,其他数字时为监控频率的倍数]

task_summary

string

任务摘要

task_create_time

string

任务创建时间,时间戳

task_status

string

任务状态,[1-开启 3-暂停]

account_id

string

帐号id

last_check_time

string

最后监控时间

last_modify_time

string

最后修改时间

mw_time

string

维护窗口起始时间

mw_duration

string

维护窗口时长

hasOverseasMonitor

Int

任务是否选择有海外监测点

pattern_str_type

string

可选枚举值(4包含,6不包含)   ,匹配内容匹配类型

task_permission

string

任务公开范围