性能警报创建
方法:POST
Content-Type:application/x-www-form-urlencoded
https://network.tingyun.com/network-pro/api/alarm/addPerf-json-authkey
API依赖关系
task_id_str:需要请求任务列表接口获取警报ID。
field:需要请求警报条件选择接口 获取对应任务类型下的 based_on 参数。
recipient_group_id_str:需要请求联系人接口,获取联系人分组id。
isp_id:isp_ip字段isp excel列表。
city_id:city_id字段 city excel 列表。
API调用流程图
- 需要请求任务列表接口获取警报id,获取关键参数:task_id_str。
- 需要请求警报条件选择接口,获取关键参数:field。
- 需要请求联系人接口,获取关键参数: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 | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,T:总下载时间(5,10,s),U:首屏时间(3,8,s),D:(dns时间,100,200,ms),F:首包时间(100,200,ms),C:建立连接时间(100,200,ms),EL:页面对象数(200,100,个),CE:元素错误数(50,100,个),BY:总下载字节数(1000,2000,KB),PB:基础页面下载字节数(300,500,KB),HC:主机覆盖率(95,80,%),CET:证书过期时间(30,15,天) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| if_aval | Integer | 否 | 默认值:1 | 是否启用可用性值阈值配置,0:否,1:是。【设置该值后,必须配置可用性普通阈值(aval_threshold)和可用性严重阈值(aval_threshold_serious)】 |
| aval_threshold | Double | 否 | -- | 可用性阈值 普通警报 |
| aval_threshold_serious | Double | 否 | -- | 可用性阈值 严重警报,默认值:80 |
| aval_threshold_increase | Double | 否 | -- | 可用性阈值 警报解除上浮百分比 |
| trigger_on | Integer | 否 | 默认值:2 | 警告触发条件。1:当性能和可用性都满足阈值条件时触发,2:当性能或可用性之一满足阈值条件时触发 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| 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_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| ignore_error | String | 否 | -- | 排除的错误类型,多个以逗号分隔,比如 1,2,3 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
文件监测
| 字段名 | 类型 | 必填 | 选项 | 描述 |
|---|---|---|---|---|
| authkey | string | 是 | -- | 授权码 |
| task_id_str | String | 是 | -- | 单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type | Integer | 是 | 12 | 任务类型 |
| name | String | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,T:总下载时间(5.0,10.0,s),D:Dns解析总时间(100,200,ms),F:首包时间(100,200,ms),C:建立连接时间(100,200,ms),EL:页面对象数(200,100,个),CE:元素错误量(50,100,个),BY:总下载字节数(1000,2000,KB),PB:基础页面下载字节数(300,500,KB),HC:主机覆盖率(95,80,%),CET:证书过期时间(30,15,天) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| if_aval | Integer | 否 | 默认值:1 | 是否启用可用性值阈值配置,0:否,1:是。【设置该值后,必须配置可用性普通阈值(aval_threshold)和可用性严重阈值(aval_threshold_serious)】 |
| aval_threshold | Double | 否 | -- | 可用性阈值 普通警报 |
| aval_threshold_serious | Double | 否 | -- | 可用性阈值 严重警报,默认值:80 |
| aval_threshold_increase | Double | 否 | -- | 可用性阈值 警报解除上浮百分比 |
| trigger_on | Integer | 否 | 默认值:2 | 警告触发条件。1:当性能和可用性都满足阈值条件时触发,2:当性能或可用性之一满足阈值条件时触发 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| 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 |
| city_group | Integer | 否 | 默认值:-1,city_id为空 | 城市选项-1:全部 0:指定。当此值为-1时,city_id为空 |
| city_id | String | 否 | -- | 选中的城市ID集合,多个以逗号分隔,比如 1,2,3 下载excel数据,比如 1,2,3 |
| max_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| ignore_error | String | 否 | -- | 排除的错误类型,多个以逗号分隔,比如 1,2,3 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
Ping监测
| 字段名 | 类型 | 必填 | 选项 | 描述 |
|---|---|---|---|---|
| authkey | string | 是 | -- | 授权码 |
| task_id_str | String | 是 | -- | 单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type | Integer | 是 | 0 | 任务类型 |
| name | String | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,PA:平均延时(100,200,ms),PPL:丢包率(3,5,%),HC:主机覆盖率(95,80,%) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| 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_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| ignore_error | String | 否 | -- | 排除的错误类型,多个以逗号分隔,比如 1,2,3 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
事务监测
| 字段名 | 类型 | 必填 | 选项 | 描述 |
|---|---|---|---|---|
| authkey | string | 是 | -- | 授权码 |
| task_id_str | String | 是 | -- | 单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type | Integer | 是 | 2 | 任务类型 |
| name | String | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,T:总下载时间(5,10,s),U:首屏时间(3,8,s),D:dns时间(100,200,ms),F:首包时间(100,200,ms),C:建立连接时间(100,200,ms),EL:页面对象数(200,100,个),CE:元素错误数(50,100,个),BY:总下载字节数(1000,2000,KB),PB:基础页面下载字节数(300,500,KB) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| if_aval | Integer | 否 | 默认值:1 | 是否启用可用性值阈值配置,0:否,1:是。【设置该值后,必须配置可用性普通阈值(aval_threshold)和可用性严重阈值(aval_threshold_serious)】 |
| aval_threshold | Double | 否 | -- | 可用性阈值 普通警报 |
| aval_threshold_serious | Double | 否 | -- | 可用性阈值 严重警报,默认值:80 |
| aval_threshold_increase | Double | 否 | -- | 可用性阈值 警报解除上浮百分比 |
| trigger_on | Integer | 否 | 默认值:2 | 警告触发条件。1:当性能和可用性都满足阈值条件时触发,2:当性能或可用性之一满足阈值条件时触发 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| 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_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| ignore_error | String | 否 | -- | 排除的错误类型,多个以逗号分隔,比如 1,2,3 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
流媒体监测
| 字段名 | 类型 | 必填 | 选项 | 描述 |
|---|---|---|---|---|
| authkey | string | 是 | -- | 授权码 |
| task_id_str | String | 是 | -- | 单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type | Integer | 是 | 3 | 任务类型 |
| name | String | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,WT:等待时间(5,10,s), BF:缓冲时间(2,5,s),RB:再缓冲时间(2,5,s),UI:用户体验指数(10,20,s),FPS:流媒体首播时间(2,5,s),HC:主机覆盖率(95,80,%) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| if_aval | Integer | 否 | 默认值:1 | 是否启用可用性值阈值配置,0:否,1:是。【设置该值后,必须配置可用性普通阈值(aval_threshold)和可用性严重阈值(aval_threshold_serious)】 |
| aval_threshold | Double | 否 | -- | 可用性阈值 普通警报 |
| aval_threshold_serious | Double | 否 | -- | 可用性阈值 严重警报,默认值:80 |
| aval_threshold_increase | Double | 否 | -- | 可用性阈值 警报解除上浮百分比 |
| trigger_on | Integer | 否 | 默认值:2 | 警告触发条件。1:当性能和可用性都满足阈值条件时触发,2:当性能或可用性之一满足阈值条件时触发 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| 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_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| ignore_error | String | 否 | -- | 排除的错误类型,多个以逗号分隔,比如 1,2,3 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
MTR监测
| 字段名 | 类型 | 必填 | 选项 | 描述 |
|---|---|---|---|---|
| authkey | string | 是 | -- | 授权码 |
| task_id_str | String | 是 | -- | 单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type | Integer | 是 | 7 | 任务类型 |
| name | String | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,MPAT:平均延时(100,200,ms),MPLT:丢包率(3,5,%) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| 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_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
私有协议
| 字段名 | 类型 | 必填 | 选项 | 描述 |
|---|---|---|---|---|
| authkey | string | 是 | -- | 授权码 |
| task_id_str | String | 是 | -- | 单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type | Integer | 是 | 255 | 任务类型 |
| name | String | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,T:性能(5,10,s) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| if_aval | Integer | 否 | 默认值:1 | 是否启用可用性值阈值配置,0:否,1:是。【设置该值后,必须配置可用性普通阈值(aval_threshold)和可用性严重阈值(aval_threshold_serious)】 |
| aval_threshold | Double | 否 | -- | 可用性阈值 普通警报 |
| aval_threshold_serious | Double | 否 | -- | 可用性阈值 严重警报,默认值:80 |
| aval_threshold_increase | Double | 否 | -- | 可用性阈值 警报解除上浮百分比 |
| trigger_on | Integer | 否 | 默认值:2 | 警告触发条件。1:当性能和可用性都满足阈值条件时触发,2:当性能或可用性之一满足阈值条件时触发 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| 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_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| ignore_error | String | 否 | -- | 排除的错误类型,多个以逗号分隔,比如 1,2,3 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
移动业务
页面监测
| 字段名 | 类型 | 必填 | 选项 | 描述 |
|---|---|---|---|---|
| authkey | string | 是 | -- | 授权码 |
| task_id_str | String | 是 | -- | 单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type | Integer | 是 | 102 | 任务类型 |
| name | String | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,T:总下载时间(5,10,s),U:首屏时间(3,8,s),D:dns时间(100,200,ms),F:首包时间(100,200,ms),C:建立连接时间(100,200,ms),EL:页面对象数(200,100,个),CE:元素错误数(50,100,个),BY:总下载字节数(1000,2000,KB),PB:基础页面下载字节数(300,500,KB) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| if_aval | Integer | 否 | 默认值:1 | 是否启用可用性值阈值配置,0:否,1:是。【设置该值后,必须配置可用性普通阈值(aval_threshold)和可用性严重阈值(aval_threshold_serious)】 |
| aval_threshold | Double | 否 | -- | 可用性阈值 普通警报 |
| aval_threshold_serious | Double | 否 | -- | 可用性阈值 严重警报,默认值:80 |
| aval_threshold_increase | Double | 否 | -- | 可用性阈值 警报解除上浮百分比 |
| trigger_on | Integer | 否 | 默认值:2 | 警告触发条件。1:当性能和可用性都满足阈值条件时触发,2:当性能或可用性之一满足阈值条件时触发 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| 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_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| ignore_error | String | 否 | -- | 排除的错误类型,多个以逗号分隔,比如 1,2,3 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
文件监测
| 字段名 | 类型 | 必填 | 选项 | 描述 |
|---|---|---|---|---|
| authkey | string | 是 | -- | 授权码 |
| task_id_str | String | 是 | -- | 单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type | Integer | 是 | 1021 | 任务类型 |
| name | String | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,T:总下载时间(5,10,s),D:dns时间(100,200,ms),F:首包时间(100,200,ms),C:建立连接时间(100,200,ms),EL:页面对象数(200,100,个),CE:元素错误数(50,100,个),BY:总下载字节数(1000,2000,KB),PB:基础页面下载字节数(300,500,KB) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| if_aval | Integer | 否 | 默认值:1 | 是否启用可用性值阈值配置,0:否,1:是。【设置该值后,必须配置可用性普通阈值(aval_threshold)和可用性严重阈值(aval_threshold_serious)】 |
| aval_threshold | Double | 否 | -- | 可用性阈值 普通警报 |
| aval_threshold_serious | Double | 否 | -- | 可用性阈值 严重警报,默认值:80 |
| aval_threshold_increase | Double | 否 | -- | 可用性阈值 警报解除上浮百分比 |
| trigger_on | Integer | 否 | 默认值:2 | 警告触发条件。1:当性能和可用性都满足阈值条件时触发,2:当性能或可用性之一满足阈值条件时触发 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| recipient_group_id_str | String | 是 | -- | 接收组ID集合,多个以逗号分隔,比如 1,2,3 |
| 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_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| ignore_error | String | 否 | -- | 排除的错误类型,多个以逗号分隔,比如 1,2,3 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
Ping监测
| 字段名 | 类型 | 必填 | 选项 | 描述 |
|---|---|---|---|---|
| authkey | string | 是 | -- | 授权码 |
| task_id_str | String | 是 | -- | 单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type | Integer | 是 | 100 | 任务类型 |
| name | String | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,PA(5,10,s):延时,PPL:丢包率(5,10,s) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| if_aval | Integer | 否 | 默认值:1 | 是否启用可用性值阈值配置,0:否,1:是。【设置该值后,必须配置可用性普通阈值(aval_threshold)和可用性严重阈值(aval_threshold_serious)】 |
| aval_threshold | Double | 否 | -- | 可用性阈值 普通警报 |
| aval_threshold_serious | Double | 否 | -- | 可用性阈值 严重警报,默认值:80 |
| aval_threshold_increase | Double | 否 | -- | 可用性阈值 警报解除上浮百分比 |
| trigger_on | Integer | 否 | 默认值:2 | 警告触发条件。1:当性能和可用性都满足阈值条件时触发,2:当性能或可用性之一满足阈值条件时触发 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| 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_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| ignore_error | String | 否 | -- | 排除的错误类型,多个以逗号分隔,比如 1,2,3 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
事务监测
| 字段名 | 类型 | 必填 | 选项 | 描述 |
|---|---|---|---|---|
| authkey | string | 是 | -- | 授权码 |
| task_id_str | String | 是 | -- | 单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type | Integer | 是 | 103 | 任务类型 |
| name | String | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,T:总下载时间(5,10,s),U:首屏时间(3,8,s),D:dns时间(100,200,ms),F:首包时间(100,200,ms),C:建立连接时间(100,200,ms),EL:页面对象数(200,100,个),CE:元素错误量(50,100,个),BY:总下载字节数(1000,2000,KB),PB:基础页面下载字节数(300,500,KB) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| if_aval | Integer | 否 | 默认值:1 | 是否启用可用性值阈值配置,0:否,1:是。【设置该值后,必须配置可用性普通阈值(aval_threshold)和可用性严重阈值(aval_threshold_serious)】 |
| aval_threshold | Double | 否 | -- | 可用性阈值 普通警报 |
| aval_threshold_serious | Double | 否 | -- | 可用性阈值 严重警报,默认值:80 |
| aval_threshold_increase | Double | 否 | -- | 可用性阈值 警报解除上浮百分比 |
| trigger_on | Integer | 否 | 默认值:2 | 警告触发条件。1:当性能和可用性都满足阈值条件时触发,2:当性能或可用性之一满足阈值条件时触发 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| 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_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| ignore_error | String | 否 | -- | 排除的错误类型,多个以逗号分隔,比如 1,2,3 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
流媒体监测
| 字段名 | 类型 | 必填 | 选项 | 描述 |
|---|---|---|---|---|
| authkey | string | 是 | -- | 授权码 |
| task_id_str | String | 是 | -- | 单个任务时只需ID,如:123 如果是多任务时,多个ID逗号拼接,如:123,456 |
| task_type | Integer | 是 | 111 | 任务类型 |
| name | String | 是 | -- | 警报名称 |
| if_perf | Integer | 否 | 默认值:1 | 是否启用值阈值配置,0:否,1:是。【设置该值后,必须配置性能普通阈值(perf_threshold)和严重阈值(perf_threshold_serious)】 |
| field | String | 是 | 包含指标名称以及普通警报默认阈值以及严重警报默认阈值,单位,WT:等待时间(5,10,s), BF:缓冲时间(2,5,s),FF:首帧时间(2,5,s),FL:丢包率(3,5,%),FRPS:fps(60,30,个),THS:握手时间(2,5,s),FRC:卡顿次数(2,5,个),FT:卡顿时长(2,5,s),CR:卡顿率(3,5,%) | 性能指标项 |
| if_dynamic | Integer | 否 | 默认值:0 | 是否动态阈值 0:静态,1:动态,默认就是静态阈值 |
| calc_cycle | Integer | 否 | 当if_dynamic = 1时,默认:4 | 动态阈值计算周期 1:上一天;2:上周的当天;3:上周;4:上月。【该选项仅仅在动态阈值才有效,即if_dynamic = 1 时,才有效】 |
| perf_threshold | Double | 否 | -- | 性能阈值 普通警报 |
| perf_threshold_serious | Double | 否 | -- | 性能阈值 严重警报 |
| perf_threshold_increase | Double | 否 | -- | 性能阈值 警报解除上浮百分比。【该选项仅仅在静态阈值才有效,if_dynamic = 0 时】 |
| if_aval | Integer | 否 | 默认值:1 | 是否启用可用性值阈值配置,0:否,1:是。【设置该值后,必须配置可用性普通阈值(aval_threshold)和可用性严重阈值(aval_threshold_serious)】 |
| aval_threshold | Double | 否 | -- | 可用性阈值 普通警报 |
| aval_threshold_serious | Double | 否 | -- | 可用性阈值 严重警报,默认值:80 |
| aval_threshold_increase | Double | 否 | -- | 可用性阈值 警报解除上浮百分比 |
| trigger_on | Integer | 否 | 默认值:2 | 警告触发条件。1:当性能和可用性都满足阈值条件时触发,2:当性能或可用性之一满足阈值条件时触发 |
| calc_way | Integer | 否 | 默认值:0 | 统计方式 |
| 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倍】 |
| point_trigger | Integer | 否 | 默认值:1 | 触发最小样本个数 |
| min_point_error_trigger | Integer | 否 | 默认值:0 | 触发错误最小样本个数。【该配置只针对可用性触发警报时生效】 |
| group_by | Integer | 否 | 默认:0 | 分组【0:无;1:按城市;2:按运营商;3:按主机;4:按城市运营商;5:按省份;6:按省份运营商。】 |
| 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_alarm_count | Integer | 否 | 默认值:1 | 警报持续时间,【1:无,2:1分钟;3:2分钟;5:5分钟;10:10分钟;20:20分钟;30:30分钟;40:40分钟;50:50分钟;60:60分钟】 |
| max_trigger_count | Integer | 否 | 默认值:1 | 最多报警次数,取值范围【1-30】 |
| mobile_sms_mode | Integer | 否 | 默认:1 | 警报短信格式,0:纯文字警报 1:包含警报链接 |
| alarm_on_ok | Integer | 否 | 默认:1 | 网站状态恢复到正常时是否发送提醒 1:是,0:否 |
| ignore_error | String | 否 | -- | 排除的错误类型,多个以逗号分隔,比如 1,2,3 |
| if_trim | Integer | 否 | 默认:0 | 是否开启性能过滤。0:否,1:是 |
| trim_mode | Integer | 否 | 默认值:0 | 自动过滤方式 0:按总体;1:按分组方式 |
| trim_above | Integer | 否 | 当if_trim = 1时有效,默认值:95 | 以上过滤,单位百分比 |
| trim_below | Integer | 否 | 当if_trim = 1时有效,默认值:5 | 向下过滤,单位百分比 |
返回参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| status | long | 状态码 |
| data | string | 数据字段,这里返回添加完成之后的警报ID |
错误说明
| 错误码 | 错误信息 |
|---|---|
| authkey合法性校验失败 | 200002 |
| 获取警报条件失败 | 200003 |
| 获取联系人列表失败 | 200004 |
| 参数校验失败 | 200005 |
| 业务处理失败 | 200006 |
| 系统错误 | 200007 |
返回示例
{
"data": 2103511,
"status": 200
}