任务批量操作包括:
<接口地址>:/siteapi/tasks/batch
<请求方式>:POST
<请求类型>:JSON
<响应类型>:JSON
<请求参数>:
指标名称 | 是否必须 | 数据类型 | 默认值 | 描述 |
task_type | 是 | String | 无 | 目前只支持http、ping、tcp。 |
task_info_list | 是 | array | 无 | 批量任务信息数组。 数组元素为Object类型,均以”Task“表示,如“Task.task_name”。 |
Task.task_name | 是 | String | 无 | 任务名称 |
HTTP/HTTPS任务类型特有字段 | ||||
Task.url | 是 | String | 无 | 任务目标URL |
Task.ip | 否 | String | 无 | 任务目标IP |
Task.https_sslv | 否 | Int | 无 | SSL版本,适用于https监控,可选值: 0: 默认 , 1: TLSv1 , 4:TLSv1.0 , 5:TLSv1.1 , 6: TLSv1.2 选择默认时,顺序适配TLSv1 ssl版本;选择其他选项时,仅适配对应SSL版本。 |
Task.ssl_verify | 否 | Int | 无 | 是否开启ssl证书认证,可选值:
|
Task.header | 否 | Array | 无 | HTTP请求头信息 |
Ping任务类型特有字段 | ||||
Task.host | 是 | String | 无 | Ping任务目标主机 |
TCP任务类型特有字段 | ||||
Task.host | 是 | String | 无 | TCP任务目标主机 |
Task.tcp_port | 否 | Int | 无 | TCP任务指定的端口 |
所有任务类型的公共参数 | ||||
Task.network_protocol | 是 | String | 无 | 可选值:
|
Task.group_id | 是 | Int | 无 | 监测点分组ID 请按照Task.network_protocol来选择监测点分组。 |
Task.frequency | 是 | Int | 无 | 任务监控频率 |
Task.reminds | 是 | Int | 0 | 连续提醒范围 0,1, 2, 3, 5, 10, 20, 30 |
Task.retry | 否 | Int | 1 | 重试次数范围1~3 |
Task.history | 否 | Int | 0 | 是否记录快照,可选值:
|
Task.all_snapshot | 否 | Int | 0 | 是否记录全部快照,可选值:
|
Task.threshold_setting | 否 | Array | 无 | 任务告警线数组(规则参考“创建任务的自定义告警规则”) |
Task.task_scope | 是 | object | 无 | 项目公开范围 |
Task.task_scope.type | 是 | Int | 无 | 公开范围: 1:所有所在企业用户 2:用户组 3: 仅限本人 4:部分企业用户 |
Task.task_scope.organization | 否 | Array | 设定的用户组ID 设置不同公开范围,此字段值不同: 如果设置公开范围为2时,值应为所选的用户组ID数组。 设置公开范围为其他,值应为空数组或者缺省。 | |
Task.task_scope.user | 否 | Array | 设定的用户ID 设置不同公开范围,此字段值不同: 如果设置公开范围为3,4时,值应为所选的用户ID数组。(设置公开范围为3时,值应为只包含当前用户的ID数组) 设置公开范围为其他,值应为空数组或者缺省。 | |
Task.remind_setting | 否 | object | 无 | 常规告警通知设置 "email","sms",voice","push","wechat"为 指定需要以该告警通知方式通知的人员ID数组。 "remind"为指定需要连续告警通知的人员ID数组。 |
<请求示例>:
curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa" https://v6-api.jiankongbao.com/siteapi/tasks/batch -d '
{"task_type":"http","task_info_list":[{"task_name":"ssss","url":"http://dsdasd.com","ip":"",
"https_sslv":"0","ssl_verify":"","frequency":2,"reminds":1,"retry":1,"all_snapshot":0,"history":1,
"task_scope":{"type":1},"header":[],"group_id":0,"threshold_setting":[{"metric":1,"cond":1,"type":"http",
"value":2,"unit":1,"status":0,"retry":1, "monitor_set":1,"monitor_count":3,"advanced_status":2 }],
"remind_setting":{"email":[],"sms":[],"voice":[],"push":[],"wechat":[],"remind":[]}}]}'
<响应数据>:
根数据节点为数组,数组没有元素包含以下字段。
参数名称 | 数据类型 | 描述 |
order | Int | 返回数据的顺序 |
task_id | Int | 新增的任务ID(创建失败该字段返回值为空字符) |
task_name | String | 任务名称 |
task_result | String | 处理结果 |
msg | String | 提示消息 |
<响应示例>:
[ { "order":"1", "task_name":"oppo_1", "task_result":"success", "msg":"创建成功", "task_id":"12323" }, { "order":"2", "task_name":"oppo_2", "task_result":"fail", "msg":"创建失败", "task_id":"" } ]
<接口地址>:/siteapi/tasks/batch
<请求方式>:DELETE
<请求类型>:JSON
<响应类型>:JSON
<请求参数>:
指标名称 | 是否必须 | 数据类型 | 默认值 | 描述 |
task_ids | 是 | Array | 无 | 需要批量删除的任务ID数组。 |
<请求示例>:
curl -X DELETE -H "token:a3af84f7c1d0d935024ba58b5da78aaa" https://v6-api.jiankongbao.com/siteapi/tasks/batch -d '{"task_ids":[6925392,6925393]}'
<响应数据>:
根数据节点为数组,数组元素包含以下字段。
参数名称 | 数据类型 | 描述 |
order | Int | 返回数据的顺序 |
task_id | Int | 已处理的任务ID |
task_name | String | 任务名称 |
task_result | String | 处理结果 |
msg | String | 提示消息 |
<响应示例>:
[ { "order": 1, "task_name": "batch_del_2", "task_result": "success", "msg": "删除成功", "task_id": "6925393" }, { "order": 2, "task_name": "batch_del_1", "task_result": "success", "msg": "删除成功", "task_id": "6925392" } ]