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

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


<应用>:返回任务某一时间段的监测数据


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


<请求方式>:GET


<请求类型>:URL参数


<响应类型>:JSON


<请求参数>:

参数名称

是否必须

类型

默认值

描述

task_id

int

任务编号

start_time

date

开始时间

end_time

date

结束时间

sumdataonly

Int

值为1时,返回所有监测点汇总统计数据;其他值时返回各个监测点的数据


<请求示例>:

/siteapi/data/sitetask/statisticbymonitor?task_id=64&start_time=2018-01-01&end_time=2018-01-02


<响应数据>:

参数名称

数据类型

描述

data

array

数据列表

monitor_id

Int

监测点id

resp_time_avg

Float

响应时间平均值

resp_time_min

Float

响应时间最小值

resp_time_max

Float

响应时间最大值

available_rate

Float

可用率

monitorinfo

Array

监测点信息



"monitor_name": "名称",

"location_code": "区域编码",

"location_name": "区域名称",

"isp_id": "服务商编号",

"isp_name": "服务商名称",

"isp_en_name": "服务商英文名称",

"isChina": 是否中国,

"worldRegionCode": 大区编码,

"worldRegion": "大区名称",

"countryCode": "国家编码",

"country": "国家名称",

"country_en": "国家英文名称",

"chinaRegionCode": "中国区域编码",

"chinaRegion": "中国区域",

"provinceCode": "省编码",

"province": "省名称",

"province_en": "省英文名称",

"cityCode": "城市编码",

"city": "城市",

"city_en": "城市英文",

"monitorIp":   "监测点ip"


<响应示例>:

{
    "data": [
        {
            "monitor_id": 1,
            "resp_time_avg": 0,
            "resp_time_min": 0,
            "resp_time_max": 0,
            "available_rate": 100,
            "monitorinfo": {
                 "monitor_id": "1",
                "monitor_name": "陕西西安电信",
                "location_code": "100610100",
                "location_name": "西安市",
                "isp_id": "1",
                "isp_name": "电信",
                "isp_en_name": "Telecom",
                "isChina": 1,
                "worldRegionCode": "1",
                "worldRegion": "亚太",
                "countryCode": "100",
                "country": "中国",
                "country_en": "China",
                "chinaRegionCode": "1006",
                "chinaRegion": "西北",
                "provinceCode": "100610",
                "province": "陕西",
                "province_en": "Shaanxi",
                "cityCode": "100610100",
                "city": "西安市",
                "city_en": "Xi_an",
                "monitorIp": "111.222.3.4"          
 }
        },
        {
            "monitor_id": 106,
            "resp_time_avg": 1266.48,
            "resp_time_min": 65.39,
            "resp_time_max": 7766.08,
            "available_rate": 94.67,
            "monitorinfo": {
                 "monitor_id": "106",
                "monitor_name": "上海市联通",
                "location_code": "100310",
                "location_name": "上海",
                "isp_id": "2",
                "isp_name": "联通",
                "isp_en_name": "Unicom",
                "isChina": 1,
                "worldRegionCode": "1",
                "worldRegion": "亚太",
                "countryCode": "100",
                "country": "中国",
                "country_en": "China",
                "chinaRegionCode": "1003",
                "chinaRegion": "华东",
                "provinceCode": "100310",
                "province": "上海",
                "province_en": "Shanghai",
                "monitorIp": "124.133.28.7"          
 }
        }
    ]
}