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

地区

<世界大区>:

编码

描述

1

亚太

2

欧洲

3

美洲

4

非洲

5

大洋洲


中国-100

<中国大区>:

编码

描述

1001

华北

1002

东北

1003

华东

1004

中南

1005

西南

1006

西北

1007

港澳台

<海外地区>:

编码

描述

1234

海外地区

 

指标

<指标枚举>:

指标定义

描述

单位

available_rate

可用率

%

resp_time_min

最小响应时间

ms

resp_time_avg

平均响应时间

ms

resp_time_max

最大响应时间

ms

loss_min

最小丢包率

ms

loss_avg

平均丢包率

ms

loss_max

最大丢包率

ms

dns_time

DNS域名解析时间

ms

connect_time

建立连接时间

ms

process_time

首字节时间

ms

download_time

下载内容时间

ms

download_speed

下载速度

KB/s

steps

总跳数


no_steps

无响应跳数


loss

丢包跳数比

%


<任务类型支持的指标>:

任务类型

指标定义

http

available_rate,resp_time_avg,dns_time,connect_time,process_time,download_time,download_speed

ping

available_rate,resp_time_min,resp_time_avg,resp_time_max,loss_min,loss_avg,loss_max

dns

available_rate,resp_time_min,resp_time_avg,resp_time_max

ftp

available_rate,resp_time_min,resp_time_avg,resp_time_max

udp

available_rate,resp_time_min,resp_time_avg,resp_time_max

tcp

available_rate,resp_time_min,resp_time_avg,resp_time_max

traceroute

available_rateresp_time_minresp_time_avgresp_time_maxstepsno_stepsloss


<任务故障说明>:

任务类型

故障

释义

http

HTTP_ERR_RESOLVE_HOST

DNS无法解析


HTTP_ERR_CONNECT

无法连接服务器


HTTP_ERR_TIMEOUT

请求超时


HTTP_ERR_NO_REPLY

服务器无返回数据


HTTP_ERR_UNKNOWN

站点无法访问


HTTP_HEADER_ERR_NOT_PATTERN

不包含匹配头信息


HTTP_HEADER_ERR_PATTERN

包含匹配头信息


HTTP_ERR_NOT_PATTERN

不包含匹配内容


HTTP_ERR_PATTERN

包含匹配内容


HTTP_LENGTH_EXCEED

响应内容超长

ping

PING_LOSS

数据包全部丢弃

dns

DNS_NO_DOMAIN

域名不存在


DNS_NO_RES

无解析记录


DNS_NO_MATCH

DNS不匹配

tcp

TCP_RESOLVE_ERROR

DNS无法解析

TCP_CONNECT_ERROR

无法连接服务器

TCP_CONNECT_REFUSED

连接请求被拒绝

TCP_CONNECT_TIMEOUT

TCP连接超时

udp

UDP_ERROR

UDP测试失败

UDP_RESOLVE_ERROR

DNS无法解析

UDP_RECV_ERROR

服务器无响应数据

UDP_PATTERN_MATCH

不包含匹配内容

UDP_RECV_TIMEOUT

等待响应超时

ftp

FTP_ERR_CONNECT

无法连接

FTP_ERR_LOGIN

无法验证身份

websocket

WS_BAD_REQUEST

非法请求

WS_ERR_RESOLVE_HOST

DNS无法解析

WS_ERR_TLS_CERTIFICATE

SSL证书错误

WS_ERR_CONNECT

TCP连接失败

WS_ERR_WEBSOCKET_UPGRADE

Upgrade失败

WS_ERR_NO_REPLY

服务器无响应

WS_ERR_UNKNOWN

未知错误

WS_ERR_SEND_MSG

消息发送失败

WS_ERR_RECV_MSG

消息接收失败

WS_ERR_RESP_HEADER_ASSERT

响应头匹配失败

WS_ERR_RECV_CONTENT_ASSERT

消息内容匹配失败