云智慧支持中心

任务分组管理APIs包括：

获取分组列表
添加分组
修改分组名称
删除分组
获取分组下的任务列表
添加任务到分组
删除分组下的任务
分组任务Top列表

获取分组列表

接口地址：/siteapi/tasks/group/

请求方式：GET

数据类型：JSON

响应类型：JSON

响应数据：

参数名称	是否必须	数据类型	描述
data	是	array	返回的分组信息集合
name	是	string	分组名
pId	是	string	父分组node_id
id	是	string	分组id
Count	是	integer	该分组向下包含的任务个数
isParent	是	boolean	是否根节点，true是，false否

响应示例：

{
    "data": [
           {
            "id": "1317",
            "name": "测试API接口分组",
            "pId": "0",
            "Count": 1,
            "isParent": false
         }
    ],
    ........
}

添加分组

接口地址：/siteapi/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"]
}

修改分组名称

接口地址：/siteapi/tasks/group/{node_id}

请求方式：put

数据类型：JSON

响应类型：JSON

请求参数：

参数名称	是否必须	数据类型	默认值	描述
name	是	string		分组名
node_id	是	integer		分组id

响应数据：

参数名称	是否必须	数据类型	描述
node_id	是	string	成功修改的分组id

响应示例：

{
"node_id":"1326"
}

删除分组

接口地址：/siteapi/tasks/group/{node_id}

请求方式：delete

数据类型：JSON

响应类型：JSON

请求参数：

参数名称	是否必须	数据类型	默认值	描述
node_id	是	integer		分组id

响应数据：

参数名称	是否必须	数据类型	描述
node_id	是	string	成功删除的分组id

响应示例：

{
"node_id":"1326"
}

获取分组下的任务列表

接口地址：/siteapi/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	int	任务ID
task_name	String	任务名称
task_summary	String	URL或域名
task_type	String	任务类型
task_create_time	int	任务创建时间
frequency	int	监控频率
task_status	int	任务状态
group_id	Int	监控点分组id
last_check_time	int	最后监控时间
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":"4",
"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	获取任务失败

添加任务到分组

接口地址：/siteapi/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"
    ]
}

删除分组下的任务

接口地址：/siteapi/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列表

接口地址：/siteapi/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	否	string	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	float	平均可用率
resp_time_avg	float	平均响应时间

响应示例：

[
{
"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
 },
]