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

获取任务使用监测点信息包含如下两个API接口:



获取单个任务正在使用的监测点信息

<接口地址>:/siteapi/tasks/monitors/selectedmonitors

<请求方式>:get

<请求类型>:URL参数

<响应类型>:JSON

<请求参数>:

参数名称

是否必须

类型

默认值

描述

task_id

int


获取指定task_id下的监测点

location_code

int

区域编号

isp_id

int

运营商编号

<请求示例>:

Curl -H "token:1059f8cccc8d39ca5fd4e1d6fcfa376c"  https://v6-api.jiankongbao.com/siteapi/tasks/monitors/selectedmonitors?task_id=12&location_code=100&isp_id=1

<响应数据>:

参数名称

数据类型

描述

data

array


monitor_id

int

监测点ID

monitor_name

string

监测点名称

Isp_info

array

所属运营商信息

isp_id

int

运营商ID

isp_name

string

运营商名称

en_name

string

运营商英文名

location_info

array

所属地区信息

isChina

int

是否为中国,1-是,0-否

wordRegionCode

string

所属世界大区编码

wordRegion

string

所属世界大区名称

countryCode

string

所属国家编码

country

string

所属国家名称

country_en

string

所属国家英文名称

provinceCode

string

所属省份编码

province

string

所属省份名称

province_en

string

所属省份英文名称

以下选项只有中国的时候才包含

chinaRegionCode

string

所属中国大区编码

chinaRegion

string

所属中国大区名称

cityCode

string

所属城市编码

city

string

所属城市名称

city_en

string

所属城市英文名称

<响应示例>:

{
    "data": [
        {
            "monitor_id": 1,
            "monitor_name": "陕西西安电信",
            "isp_info": {
                "isp_id": 1,
                "isp_name": "电信",
                "en_name": "Telecom"
            },
            "location_info": {
                "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"
            }
        },
        {
            "monitor_id": 122,
            "monitor_name": "美国纽约市",
            "isp_info": {
                "isp_id": 7,
                "isp_name": "欧美",
                "en_name": "Europe and the United States"
            },
            "location_info": {
                "isChina": 0,
                "worldRegionCode": "3",
                "worldRegion": "美洲",
                "countryCode": "310",
                "country": "美国",
                "country_en": "United States of America",
                "provinceCode": "310120",
                "province": "纽约",
                "province_en": "City of New York"
            }
        },
        {
            "monitor_id": 164,
            "monitor_name": "山东青岛联通",
            "isp_info": {
                "isp_id": 2,
                "isp_name": "联通",
                "en_name": "Unicom"
            },
            "location_info": {
                "isChina": 1,
                "worldRegionCode": "1",
                "worldRegion": "亚太",
                "countryCode": "100",
                "country": "中国",
                "country_en": "China",
                "chinaRegionCode": "1003",
                "chinaRegion": "华东",
                "provinceCode": "100370",
                "province": "山东",
                "province_en": "Shandong",
                "cityCode": "100370200",
                "city": "青岛市",
                "city_en": "Qingdao"
            }
        }
    ]
}

 


获取批量任务正在使用的监测点信息

<接口地址>:tasks/monitors/batchtasksmonitors

<请求方式>:get

<数据类型>:JSON

<响应类型>:JSON

<请求参数>:

参数名称

是否必须

类型

默认值

描述

task_ids

string(逗号分隔的taskid)


任务id,批量监测点用逗号隔开,最多支持100个任务

location_code

int

区域编号

isp_id

int

运营商编号

<响应数据>:

参数名称

数据类型

描述

data

array


task_id

Int

任务id

monitor_list

Array

当前任务下所有的监测点信息,元素数据类型未int

<响应实例>:

{
    "data":[
        {
            "task_id":6924499,
            "monitor_list":[
 
            ]
        },
        {
            "task_id":6924500,//任务id int
            "monitor_list":[//监测点id列表 array
                2,//监测点id   int
                115,
                140
            ]
        },
        {
            "task_id":6924501,
            "monitor_list":[
                1,
                11,
                12,
                2,
                14,
                15
            ]
        },
        ......
    ]
}