错误警报创建
方法:POST
Content-Type:application/x-www-form-urlencoded
https://network.tingyun.com/network-pro/api/alarm/addError-json-authkey
API依赖关系
task_id_str:需要请求任务列表接口获取警报ID。
exist_errors:exist_errors字段 errors excel列表。
recipient_group_id_str:需要请求联系人接口,获取联系人分组id。
isp_id:isp_ip字段isp excel列表。
city_id:city_id字段 city excel 列表。
API调用流程图
- 需要请求任务列表接口获取警报id,获取关键参数:task_id_str。
- errors excel列表,获取关键参数:exist_errors。
- 需要请求联系人接口,获取关键参数:recipient_group_id_str。
- isp excel列表,获取关键参数:isp_id。
- city excel 列表,获取关键参数:city_id。
请求参数
PC业务
页面监测
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
11 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
文件监测
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
12 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
Ping监测
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
0 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
事务监测
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
2 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
流媒体监测
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
3 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
MTR监测
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
7 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
私有协议
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
255 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
移动业务
页面监测
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
102 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
文件监测
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
1021 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
Ping监测
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
100 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
事务监测
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
103 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
流媒体监测
| 字段名 |
类型 |
必填 |
选项 |
描述 |
| authkey |
string |
是 |
-- |
授权码 |
| task_id_str |
String |
是 |
-- |
单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type |
Integer |
是 |
111 |
任务类型 |
| name |
String |
是 |
-- |
警报名称 |
| exist_errors |
String |
是 |
-- |
选择错误类型,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| error_calc_way |
Integer |
否 |
默认:0 |
阈值计算规则 按错误数量:0;按错误百分比:1 |
| point_trigger |
Integer |
否 |
默认值:1 |
触发最小样本个数 |
| error_count |
Double |
是 |
-- |
错误阈值 普通警报 |
| error_count_serious |
Double |
是 |
-- |
错误阈值 严重警报 |
| error_count_increase |
Double |
否 |
-- |
警报解除上浮百分比 |
| sample_mode |
Integer |
否 |
默认值:1 |
取样方式:0:固定取样间隔, 1:动态取样间隔 |
| based_on |
Integer |
否 |
sample_mode = 1时,默认值:1 sample_mode = 0时,默认值:5 |
取样间隔频率,【sample_mode = 0时,固定取样频率枚举,5:5分钟;10:10分钟;15:15分钟;20:20分钟;30:30分钟;60:1小时;120:2小时 sample_mode = 1时,动态取样范围枚举,1:1倍;2:2倍;3:3倍;4:4倍;5:5倍;10:10倍】 |
| recipient_group_id_str |
String |
是 |
-- |
接收组ID集合,以逗号分隔 |
| locale |
String |
否 |
默认:zh_CN |
警报语言 中文:zh_CN;英文:en |
| by_isp |
Integer |
否 |
默认值:1, isp_id为空 |
运营商选项 1:全部 ;-1:指定。当此值为1时,isp_id为空 |
| isp_id |
String |
否 |
-- |
选中的运营商ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据 |
| city_group |
Integer |
否 |
默认值:-1,city_id为空 |
城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id |
String |
否 |
-- |
选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_trigger_count |
Integer |
否 |
默认值:1 |
最多报警次数,取值范围【1-30】 |
| mobile_sms_mode |
Integer |
否 |
默认:1 |
警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok |
Integer |
否 |
默认:1 |
网站状态恢复到正常时是否发送提醒 1:是,0:否 |
返回参数
| 字段名 |
类型 |
描述 |
| status |
long |
状态码 |
| data |
string |
数据字段,这里返回添加完成之后的警报ID |
错误说明
| 错误码 |
错误信息 |
| authkey合法性校验失败 |
200002 |
| 获取警报条件失败 |
200003 |
| 获取联系人列表失败 |
200004 |
| 参数校验失败 |
200005 |
| 业务处理失败 |
200006 |
| 系统错误 |
200007 |
返回示例
{
"data": 2103511,
"status": 200
}