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

说明:时间维度,时间筛选范围7天内按小时维度返回数据,大于7天按天维度返回数据。


<应用>:按时间和监测点,返回任务平均响应时间的值,可以获取到响应时间最慢的监测点


<接口地址>:/siteapi/data/sitetask/resptimebytimescale


<请求方式>:GET


<请求类型>:URL参数


<响应类型>:JSON


<请求参数>:

参数名称

是否必须

类型

默认值

描述

task_id

int

任务编号

start_time

date

开始时间

end_time

date

结束时间

location_code

Int

地区编码,当指定了monitor_id 时该参数无效。

当该值为0时,指任务所有监测点在所选时间范围内,时间维度的平均值

monitor_id

Int

监测点id。指定后,只返回该监测点的数据

monitorlimit

Int

0

返回指定监测点数量的数据,当指定了监测点id后,该参数无效(只返回目标监测点的数据)。

0-不限。0返回全部监点在所选时间范围内,时间维度的平均值

n-指定数量。n 返回响应时间最慢的前n个监测点在所选时间范围内,时间维度的数据

limit_fieldStringresp_time_avg

排序字段(只有当设置了monitorlimit参数后才有效)。

可选值:resp_time_avg,avail_ resp_time_avg。


<请求示例>:

curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa"  https://v6-api.jiankongbao.com/siteapi/data/sitetask/resptimebytimescale?task_id=64&start_time=2018-01-01&end_time=2018-01-02&monitorlimit=1


<响应数据>:

参数名称

数据类型

描述

data

array

数据列表

check_time

Int

检测时间

resp_time_avg

Float

响应时间平均值(全部)

avail_resp_time_avg


Float响应时间平均值(可用)

resp_time_min

Float

响应时间最小值(全部)

avail_resp_time_min


Float响应时间最小值(可用)
resp_time_max

Float

响应时间最大值(全部)

avail_resp_time_max

Float

响应时间最大值(可用)

monitorname

string

监测点名称


<响应示例>: 

 {
    "data": [
        [
            {
                "monitor_id": 2,
                "monitorname": "辽宁大连联通",
                "check_time": 1516809600,
                "resp_time_min": 29.95, "avial_resp_time_min": 29.95,
                "resp_time_max": 36.46, "avail_resp_time_max": 36.46,
                "resp_time_avg": 32.45,"avail_resp_time_avg": 32.45[MOU1] 
  [MOU1]
            },
            {
                "monitor_id": 2,
                "monitorname": "辽宁大连联通",
                "check_time": 1516813200,
                "resp_time_min": 29.95, "avial_resp_time_min": 29.95,
                "resp_time_max": 36.46, "avail_resp_time_max": 36.46,
                "resp_time_avg": 32.45,"avail_resp_time_avg": 32.45 
            }
        ]
    ]
}