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

统计的任务指标包括:响应时间最快、最慢、平均,平均可用率,故障

<接口地址> /siteapi/data/task/statistics/info

<请求方式> GET

<请求类型>: URL路径参数

<响应类型>:JSON

<请求参数>

参数名称

是否必须

参数类型

默认值

示例

备注

task_id

int


任务id

start_time

datetime


当天开始时间

开始时间(与end_time需同时设置才生效)

end_time

datetime


当前时间

结束时间(与start_time同时设置才生效)

location_code

int


设置后,只统计location_code下的监测点的数据

isp_id

int


设置后,只统计isp_id下的监测点的数据

monitor_id

int



监测点id(仅支持单个监测点)

<请求示例>

curl -H "token:ac28abc6871123b4877dabbc9e1ad5a9" "http://dev.jkb.com:28080/siteapi/data/task/statistics/info?end_time=2022-04-30+09:53&random=1656035746480&start_time=2022-04-01+03:00&task_id=37350556&monitor_id=170"

<响应参数>

名称

类型

是否必须

默认值

备注

其他信息

 check_count

string

非必须


监测次数

备注: 监测次数

 fault_count

string

非必须


故障次数

备注: 故障次数

 resp_time_max

string

非必须


最慢响应时间

备注: 最慢响应时间

 resp_time_min

string

非必须


最快响应时间

备注: 最快响应时间

 avail_resp_time_max

string

非必须


可用监测点最慢响应时间

备注: 可用监测点最慢响应时间

 avail_resp_time_min

string

非必须


可用监测点最快响应时间

备注: 可用监测点最快响应时间

 resp_time_avg

string

非必须


平均响应时间

备注: 平均响应时间

 avail_resp_time_avg

string

非必须


可用监测点平均响应时间

备注: 可用监测点平均响应时间

 all_monitor_fault_count

string

非必须


所有故障次数

备注: 所有故障次数

 all_monitor_check_count

string

非必须


所有监测次数

备注: 所有监测次数

 avail_rate_avg

string

非必须


平均可用率

备注: 平均可用率

 fault_time

string

非必须


故障时间

备注: 故障时间

 fault_time_str

string

非必须


故障时间

备注: 故障时间

 loss

string

必须


丢包率(仅ping/traceroute)任务有此字段

备注: 丢包率(仅ping/traceroute)任务有此字段

<响应示例>:

{
    "check_count":"46413",
    "fault_count":"43145",
    "resp_time_max":"22994.73",
    "resp_time_min":"131.24",
    "avail_resp_time_max":"7664.26",
    "avail_resp_time_min":"135.6",
    "resp_time_avg":"800.42",
    "avail_resp_time_avg":"1235.07",
    "all_monitor_fault_count":"43145",
    "all_monitor_check_count":"46413",
    "avail_rate_avg":"7.04",
    "fault_time":"-",
    "fault_time_str":"0"
}