<接口地址>:/siteapi/tasks/threshold/
<请求方式>:POST
<请求类型>:JSON
<响应类型>:JSON
<请求参数>:
名称 | 是否必填 | 数据类型 | 默认值 | 描述 |
task_id | 是 | Int | 任务ID | |
setting | 是 | array | 自定义告警设置 | |
status | 是 | Int | 状态[0-开启,1-暂停] | |
告警指标1-当前响应时间(支持的任务类型:http/ping/dns/ftp/tcp/udp) | ||||
metric | 是 | Int | 告警指标[1-当前响应时间] | |
cond | 是 | Int | 条件 [1-大于] | |
unit | 是 | Int | 单位 [1-ms] | |
value | 是 | Int | 告警阈值 | |
monitor_set | 是 | Int | 针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均] | |
monitor_count | 否 | Int | 监测点个数,monitor_set设置为1时必须填写 | |
dev | 否 | array | 指定检测的数组,monitor_set设置为2时必须填写 | |
advanced_status | 是 | Int | 高级告警策略[1,2],1为开启,2为关闭 | |
monitor_trigger_type | 否 | Int | 2 | 触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1且monitor_set为1时为必填字段 |
advanced_strategy_type | 否 | int | 1 | 高级策略类型[1-连续策略,2-累计策略] |
retry | 否 | Int | 连续触发几次即告警[2,3,4,5,6,7,8,9,10];当advance_status为1时为必填字段 | |
recover_continuous_times | 否 | int | 连续恢复几次即恢复[1,2,3,4,5] | |
trigger_accumulate_times | 否 | int | 累计几次触发即告警[2] | |
告警指标2-当前丢包率(支持的任务类型:ping) | ||||
metric | 是 | Int | 告警指标[2-当前丢包率] | |
cond | 是 | Int | 条件 [1-大于] | |
unit | 是 | Int | 单位 [3-%] | |
monitor_set | 是 | Int | 针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均] | |
monitor_count | 否 | Int | 监测点个数,monitor_set设置为1时必须填写 | |
dev | 否 | array | 指定检测的数组,monitor_set设置为2时必须填写 | |
advanced_status | 是 | Int | 高级告警策略[1,2],1为开启,2为关闭 | |
monitor_trigger_type | 否 | Int | 2 | 触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1且monitor_set为1时为必填字段 |
advanced_strategy_type | 否 | int | 1 | 高级策略类型[1-连续策略,2-累计策略] |
retry | 否 | Int | 连续触发几次即告警[2,3,4,5,6,7,8,9,10];当advance_status为1时为必填字段 | |
recover_continuous_times | 否 | int | 连续恢复几次即恢复[1,2,3,4,5] | |
trigger_accumulate_times | 否 | int | 累计几次触发即告警[2] | |
告警指标3-当日可用率(支持外网任务类型:http/ping/dns/ftp/tcp/udp) | ||||
metric | 是 | Int | 告警指标[3-当日可用率] | |
cond | 是 | Int | 条件 [2-小于] | |
unit | 是 | Int | 单位 [3-%] | |
告警指标4-不可用监测点(支持的任务类型:http/ping/dns/tcp) | ||||
metric | 是 | Int | 告警指标[4-不可用监测点] | |
monitor_set | 是 | Int | 针对分布式监测点[1-任意几个监测点,2-指定检测点] | |
monitor_count | 否 | Int | 监测点个数monitor_set设置为1时必须填写 | |
dev | 否 | array | 指定检测的数组[monitor_set设置为2时必须填写] | |
advanced_status | 是 | Int | 高级告警策略[1,2],1为开启,2为关闭 | |
monitor_trigger_type | 否 | Int | 2 | 触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1且monitor_set为1时为必填字段 |
advanced_strategy_type | 否 | int | 1 | 高级策略类型[1-连续策略,2-累计策略] |
retry | 否 | Int | 连续触发几次即告警[2,3,4,5,6,7,8,9,10];当advance_status为1时为必填字段 | |
recover_continuous_times | 否 | Int | 连续恢复几次即恢复[1,2,3,4,5] | |
trigger_accumulate_times | 否 | Int | 累计几次触发即告警[2] | |
cond | 否 | string | 故障类型,默认为11(任意故障);12(指定故障) | |
unit | 否 | string | 自定义故障,当cond=12时,填写本项,根据类型选择不可混用。多个故障用英文逗号(,)隔开。可选项: 参考<不可用监测点指定故障可选项> | |
告警指标4-不可用监测点(支持的任务类型:ftp/udp) | ||||
metric | 是 | Int | 告警指标[4-不可用监测点] | |
monitor_set | 是 | Int | 针对分布式监测点[1-任意几个监测点,2-指定检测点] | |
monitor_count | 否 | Int | 监测点个数monitor_set设置为1时必须填写 | |
dev | 否 | array | 指定检测的数组[monitor_set设置为2时必须填写] | |
cond | 否 | string | 故障类型,默认为11(任意故障);12(指定故障) | |
unit | 否 | string | 自定义故障,当cond=12时,填写本项。多个故障用英文逗号(,)隔开。可选项: 参考<不可用监测点指定故障可选项> | |
告警指标5-响应状态码(支持的任务类型:http) | ||||
metric | 是 | Int | 告警指标[5-响应状态码] | |
cond | 是 | Int | 条件 [7-等于] | |
value | 是 | Int | [301,302,400,401,502,503,504] | |
unit | 是 | Int | 单位 [4-无单位] | |
monitor_set | 是 | Int | 针对分布式监测点[1-任意几个监测点,2-指定检测点] | |
monitor_count | 否 | Int | 监测点个数monitor_set设置为1时必须填写 | |
dev | 否 | array | 指定检测的数组[monitor_set设置为2时必须填写] | |
advanced_status | 是 | Int | 高级告警策略[1,2],1为开启,2为关闭 | |
monitor_trigger_type | 否 | Int | 2 | 触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1且monitor_set为1时为必填字段 |
advanced_strategy_type | 否 | int | 1 | 高级策略类型[1-连续策略,2-累计策略] |
retry | 否 | Int | 连续触发几次即告警[2,3,4,5,6,7,8,9,10];当advance_status为1时为必填字段 | |
recover_continuous_times | 否 | int | 连续恢复几次即恢复[1,2,3,4,5] | |
trigger_accumulate_times | 否 | int | 累计几次触发即告警[2] | |
告警指标6-当前响应时间(可用)(支持的任务类型:http/ping/dns/ftp/tcp/udp) | ||||
metric | 是 | Int | 告警指标[6-当前响应时间(可用)] | |
cond | 是 | Int | 条件 [1-大于] | |
unit | 是 | Int | 单位 [1-ms] | |
value | 是 | Int | 告警阈值 | |
monitor_set | 是 | Int | 针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均] | |
monitor_count | 否 | Int | 监测点个数,monitor_set设置为1时必须填写 | |
dev | 否 | array | 指定检测的数组,monitor_set设置为2时必须填写 | |
advanced_status | 是 | Int | 高级告警策略[1,2],1为开启,2为关闭 | |
monitor_trigger_type | 否 | Int | 2 | 触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1且monitor_set为1时为必填字段 |
advanced_strategy_type | 否 | int | 1 | 高级策略类型[1-连续策略,2-累计策略] |
retry | 否 | Int | 连续触发几次即告警[2,3,4,5,6,7,8,9,10];当advance_status为1时为必填字段 | |
recover_continuous_times | 否 | int | 连续恢复几次即恢复[1,2,3,4,5] | |
trigger_accumulate_times | 否 | int | 累计几次触发即告警[2] | |
TraceRoute特殊参数-总跳数 | ||||
metric | 是 | Int | 告警指标[300-总跳数] | |
cond | 是 | Int | 条件 [1-大于] | |
unit | 是 | Int | 单位 [4-无单位] | |
advanced_status | 是 | Int | 高级告警策略[1,2],1为开启,2为关闭 | |
monitor_trigger_type | 否 | Int | 触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段 | |
retry | 否 | Int | 连续触发几次即告警[2,3,4,5,6,7,8,9,10];当advance_status为1时为必填字段 | |
advanced_strategy_type | 否 | int | 1 | 高级策略类型[1-连续策略,2-累计策略] |
recover_continuous_times | 否 | int | 连续恢复几次即恢复[1,2,3,4,5,] | |
trigger_accumulate_times | 否 | int | 累计几次触发即告警[2] | |
TraceRoute特殊参数-不响应跳数 | ||||
metric | 是 | Int | 告警指标[301-不响应跳数] | |
cond | 是 | Int | 条件 [1-大于] | |
unit | 是 | Int | 单位 [4-无单位] | |
advanced_status | 是 | Int | 高级告警策略[1,2],1为开启,2为关闭 | |
retry | 否 | Int | 连续触发几次即告警[2,3,4,5,6,7,8,9,10];当advance_status为1时为必填字段 | |
advanced_strategy_type | 否 | int | 1 | 高级策略类型[1-连续策略,2-累计策略] |
recover_continuous_times | 否 | int | 连续恢复几次即恢复[1,2,3,4,5] | |
trigger_accumulate_times | 否 | int | 累计几次触发即告警[2] | |
TraceRoute特殊参数-丢包跳数比 | ||||
metric | 是 | Int | 告警指标[302-丢包跳数比] | |
cond | 是 | Int | 条件 [1-大于] | |
unit | 是 | Int | 单位 [3-%] | |
advanced_status | 是 | Int | 高级告警策略[1,2],1为开启,2为关闭 | |
retry | 否 | Int | 连续触发几次即告警[2,3,4,5,6,7,8,9,10];当advance_status为1时为必填字段 | |
advanced_strategy_type | 否 | int | 1 | 高级策略类型[1-连续策略,2-累计策略] |
recover_continuous_times | 否 | int | 连续恢复几次即恢复[1,2,3,4,5] | |
trigger_accumulate_times | 否 | int | 累计几次触发即告警[2] | |
TraceRoute特殊参数-响应时间 | ||||
metric | 是 | Int | 告警指标[303-响应时间] | |
cond | 是 | Int | 条件 [1-大于] | |
unit | 是 | Int | 单位 [1-ms] | |
advanced_status | 是 | Int | 高级告警策略[1,2],1为开启,2为关闭 | |
retry | 否 | Int | 连续触发几次即告警[2,3,4,5,6,7,8,9,10];当advance_status为1时为必填字段 | |
advanced_strategy_type | 否 | int | 1 | 高级策略类型[1-连续策略,2-累计策略] |
recover_continuous_times | 否 | int | 连续恢复几次即恢复[1,2,3,4,5,] | |
trigger_accumulate_times | 否 | int | 累计几次触发即告警[2] |
<不可用监测点指定故障可选项>
http任务:HTTP_ERR_NOT_PATTERN,HTTP_ERR_PATTERN,HTTP_LENGTH_EXCEED,HTTP_ERR_RESOLVE_HOST,
HTTP_ERR_CONNECT,HTTP_ERR_TIMEOUT,HTTP_ERR_NO_REPLY,HTTP_ERR_UNKNOWN,HTTP_HEADER_ERR_NOT_PATTERN,HTTP_HEADER_ERR_PATTERN
ping任务:PING_LOSS
dns任务:DNS_NO_DOMAIN,DNS_NO_RES,DNS_NO_MATCH
tcp任务:TCP_RESOLVE_ERROR,TCP_CONNECT_ERROR,TCP_CONNECT_REFUSED,TCP_CONNECT_TIMEOUT
websockt任务:WS_BAD_REQUEST,WS_ERR_RESOLVE_HOST,WS_ERR_TLS_CERTIFICATE,WS_ERR_CONNECT,WS_ERR_WEBSOCKET_UPGRADE,
WS_ERR_NO_REPLY,WS_ERR_UNKNOWN,WS_ERR_SEND_MSG,WS_ERR_RECV_MSG,WS_ERR_RESP_HEADER_ASSERT,WS_ERR_RECV_CONTENT_ASSERT
ftp任务:FTP_ERR_CONNECT,FTP_ERR_LOGIN
udp任务:UDP_ERROR,UDP_RESOLVE_ERROR,UDP_RECV_ERROR,UDP_PATTERN_MATCH,UDP_RECV_TIMEOUT
<请求示例>:
curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa" https://v6-api.jiankongbao.com/siteapi/tasks/threshold/ -d '{"task_id": 684351,"setting": [{"metric": 1,"cond": 1,"unit": 1,"value": 200,"status": 0,"retry": 3,"monitor_set": 2,"dev": [1,2]}]}'
<响应数据>:
参数名称 | 数据类型 | 描述 |
th_id | Array | 成功创建返回的告警线id数组 |
<响应示例>:
{ "th_id": [ "118189" ] }