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

任务分组管理APIs包括:


获取分组列表

接口地址:/tasks/group/

请求方式:GET

数据类型:JSON

响应类型:JSON

响应数据:

参数名称

是否必须

数据类型

描述

data

array

返回的分组信息集合

name

string

分组名

pId

string

父分组node_id

id

string

分组id

count

integer

该分组向下包含的任务个数

isParent

string

是否根节点,true是,false否

响应示例:

{
    "data": [
           {
            "id": "1317",
            "name": "测试API接口分组",
            "pId": "0",
            "count": 1,
            “isParent”:true
         }
    ],
    ........
}

添加分组

接口地址:/tasks/group/

请求方式:post

数据类型:JSON

响应类型:JSON

请求参数:

参数名称

是否必须

数据类型

默认值

描述

data

Array



name

string


分组名

pId

integer


父节点id。若是根节点传0

请求样例:

{
    "data":[
        {
             "name":"华北",
             "pId":"10172"
        },
        {
             "name":"海外",
             "pId":"10172"
        }
    ]
}

响应数据:

参数名称

是否必须

数据类型

描述

node_id

array

成功创建的分组id

响应示例:

{
"node_id":["1326"]
}

修改分组名称

接口地址:/tasks/group/

请求方式:put

数据类型:JSON

响应类型:JSON

请求参数:

参数名称

是否必须

数据类型

默认值

描述

name

string


分组名

node_id

integer


分组id

响应数据:

参数名称

是否必须

数据类型

描述

node_id

string

成功修改的分组id

响应示例:

{
"node_id":"1326"
}

删除分组

接口地址:/tasks/group/

请求方式:delete

数据类型:JSON

响应类型:JSON

请求参数:

参数名称

是否必须

数据类型

默认值

描述

node_id

integer


分组id

响应数据:

参数名称

是否必须

数据类型

描述

node_id

string

成功删除的分组id

响应示例:

{
"node_id":"1326"
}

获取分组下的任务列表

接口地址:/tasks/grouptask/tasklists

请求方式:POST

数据类型:JSON

响应类型:JSON

请求参数:

参数名称

是否必须

数据类型

默认值

描述

node_id

int


分组id,必须同时设置node_type为1

node_type

int


有无分组[1,2] 1,分组,必须与node_id同时存在;2,未分组,不需要添加node_id;

task_name

string


任务名,模糊匹配

task_status

int


任务是否开启1,开启;3,暂停

trigger_status

int


告警线状态[0,1,2],0故障,1正常,2提醒

task_type

string


任务类型,可选项为'info','http','ping','ftp','smtp','tcp','udp','dns','site'

task_type_arr

array


任务类型,为数组,可一次查询多个任务类型,可选项为'info','http','ping','ftp','smtp','tcp','udp','dns','site'

task_type_arr与task_type同时存在时,采用task_type

monitor_group_id

int


监测点分组ID

page_size

int


每页多少页,可选项为[10,20,50]

current_page

int


当前页

partition_flag

String


Intranet:内网任务   External: 外网任务,不传默认查询全

请求用例:

{
“
node_id
”
:34,
”
node_type
”
:1}

响应数据:

参数名称

数据类型

描述

pagination

array

分页数据

 total_records

int

总记录数

 total_pages

int

总页数

 current_page

int

当前页

 page_size

int

分页数量

data

array

数据列表

 task_id

String

任务ID

 task_name

String

任务名称

 task_summary

String

URL或域名

 task_type

String

任务类型

 task_create_time

String

任务创建时间

 frequency

String

监控频率

 task_status

String

任务状态

group_id

Int

监控点分组id

last_check_time

String

最后监控时间

last_modify_time

String

最后修改时间

last_resp_result

Int

最后监控结果

last_resp_status

String

最后监控状态

last_resp_time

String

最后响应时间

partition_flag

String

标志是否内网,External外网任务,Intranet内网任务

status_led_str

String

任务状态灯说明

task_mtr

Int

是否打开mtr功能,1是,0否

响应示例:

{
    "data":{
        "pagination":{
            "total_records":1,
            "total_pages":1,
            "current_page":1,
            "page_size":10
        },
        "data":[
            {
                "task_id":6926448,
"task_user_id":2670,
"task_name":"mtr-http",
"task_summary":"https:\/\/cn.bing.com\/",
"task_type":"http",
"frequency":2,
"group_id":0,
"task_create_time":1583305315,
"task_status":3,
"last_resp_result":1,
"threshold_result":1,
"last_resp_status":"-",
"last_resp_time":"0.00 ms",
"last_check_time":"-",
"partition_flag":"Intranet",
"last_modify_time":"2020-09-03 09:18:30",
"network_protocol":"auto",
"task_mtr":0,
"status_led":"green",
"status_led_str":"\u6b63\u5e38",
"overview_task":0,
"last_resp_time_level":1            },
            .............
        ]
    }
}

code

msg

20072

task_node非法,必须是1或2

20077

trigger_status格式无效,必须为[0,1,2]

20076

task_type无效

20071

task_status非法,必须是1或3

20073

current_page无效,必须为大于0的正整数!

20074

page_size无效,必须为10,20,50

20075

获取任务失败

添加任务到分组

接口地址:/tasks/grouptask

请求方式:POST

数据类型:JSON

响应类型:JSON

请求参数:

参数名称

是否必须

数据类型

默认值

描述

data

array


待添加任务分组的数据

node_id

integer


分组id

task_id

integer


任务id

请求用例:

{
    "data":[
        {
            "node_id":698,
            "task_id":6921843
        },
        {
            "node_id":698,
            "task_id":6921844
        },
        {
            "node_id":69823424,
            "task_id":6921844
        }
 
    ]
}

响应数据:

参数名称

是否必须

数据类型

描述

success

array

添加成功返回的id数组

响应示例:

{
    "success":[
        "4057",
        "4058"
    ]
}

删除分组下的任务

接口地址:/tasks/grouptask

请求方式:DELETE

数据类型:JSON

响应类型:JSON

请求参数:

参数名称

是否必须

数据类型

默认值

描述

data

array


待添加任务分组的数据

node_id

integer


分组id

task_id

integer


任务id

请求用例:

{
    "data":[
        {
            "node_id":698,
            "task_id":6921843
        },
        {
            "node_id":698,
            "task_id":6921844
        },
        {
            "node_id":69823424,
            "task_id":6921844
        }
    ]
}

响应数据:

参数名称

是否必须

数据类型

描述

success

array

删除任务返回的数组信息

响应示例:

{
    "success":[
        "task_id:6921843,node_id:698,sequence:0",
        "task_id:6921844,node_id:698,sequence:1"
    ]
}

分组任务Top列表

接口地址:/tasks/grouptask/Toplist

请求方式:get

数据类型:JSON

响应类型:JSON

请求参数:

参数名称

是否必须

数据类型

默认值

描述

node_id

integer


分组id

task_type

string


任务类型

top_metric

integer

avail_rate_avg

排序指标 可选avail_rate_avg和resp_time_avg,若非法值时,强制为avail_rate_avg

top_num

integer

10

 Top N

top_sort

integer

desc

排序,可选desc和asc

start_time

string

今天0:00:00

起始时间

end_time

string

当前时间

结束时间

请求用例:

/tasks/grouptask/Toplist?node_id=784&start_time=2020-09-1&end_time=2020-10-22&top_num=5&top_metric=resp_time_avg

响应数据:

参数名称

数据类型

描述

task_id

integer

删除任务返回的数组信息

avail_rate_avg

flout

平均可用率

resp_time_avg

flout

平均响应时间

响应示例:

[
{
"task_id": 6926484,
 "avail_rate_avg": 0,
"resp_time_avg": 8632.88
},
{
"task_id": 6926480,
 "avail_rate_avg": 83.8,
 "resp_time_avg": 7442.21
 },
]