获取指定任务的报警历史。

请求说明

客户端监控已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地选择最合适的接入点。

请求地址：https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=MiniProAlarmHistory&Version=2024-03-12

请求参数

下方仅列出该接口特有的请求参数和部分公共参数，更多详细信息参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	MiniProAlarmHistory	接口名称。当前 API 的名称为 MiniProAlarmHistory。
Version	String	是	2024-03-12	接口版本。当前 API 的版本为 2024-03-12。
common	Object of Common	是	-	通用参数。
time_filter	Object of TimeFilter	是	-	时间区间。
id	Long	否	302	报警任务ID列表。
page_size	Integer	否	10	报警历史列表返回项数。
page_num	Integer	否	1	报警历史列表页数。

Common

TimeFilter

请求示例

返回参数

Data

参数	类型	示例值	描述
alarm_histories	Array of AlarmHistories	-	报警历史详情。

AlarmHistories

AlarmParam

参数	类型	示例值	描述
id	Long	302	报警任务ID。
name	String	test	报警任务名称。
desc	String	-	报警说明。
is_close	Integer	0	是否关闭报警。 0：开启 1：关闭
category	String	performance	报警类型。
category_label	String	-	报警类型名称。不填时返回全部报警类型的报警任务，非空时返回指定报警类型的报警任务，调用GetAlarmMeta接口查看取值。
alarm_level	String	warning	报警级别。 warning fatal
strategy_list	Array of StrategyList	-	报警策略列表。
strategy_op	String	and	报警多策略关系。 and：同时满足所有策略 or：满足任一策略
interval_seconds	Integer	300	报警任务执行间隔。 300：5分钟 600：10分钟 1800：30分钟 3600：60分钟
alarm_period	Object of AlarmPeriod	-	报警生效时间。
notify_config	Object of NotifyConfig	-	报警任务通知配置。
is_avoid_spike	Boolean	false	是否屏蔽尖刺报警。

AlarmResult

参数	类型	示例值	描述
is_alarm	Boolean	true	是否报警。
strategy_result_list	Array of StrategyResultList	-	分策略报警结果。

StrategyList

参数	类型	示例值	描述
id	String	123-456	报警ID。
measure	Object of Measure	-	当前策略的指标集合，包括普通指标和复合指标。
filter_list	Array of FilterList	[]	报警策略筛选条件。
alarm_strategy_type	String	threshold	报警策略类型。 threshold：阈值报警 cmp_last_n_day：比值报警
daily_compare_count	Integer	5	上一周期与当前周期的时间间隔。当报警策略为比值报警时必填，分钟单位，比如比前1天值为1440。
alarm_threshold	Double	0	报警阈值。
threshold_cmp_op	String	gte	策略符号。可选值为比值报警时，取值为gt、lt 可选值为阈值报警时，取值为lt、lte、gt、gte
alarm_user_threshold	Double	0	用户数阈值。
alarm_sample_threshold	Double	0	样本数量阈值。
alarm_window_size	Long	180	报警任务查询时间窗口，表示最近X分钟。单位为分钟。

AlarmPeriod

参数	类型	示例值	描述
start_time	Integer	0	报警生效开始时间。值为开始时间相对当天0点的秒时间戳，比如生效开始时间为当天2点，值为7200。
end_time	Integer	86399	报警生效结束时间。值为结束时间相对当天0点的秒时间戳，比如生效结束时间为当天23:59:59，值为86399。

NotifyConfig

参数	类型	示例值	描述
notify_types	Array of String	[ "mail" ]	报警任务通知方式。 mail：邮箱 lark：飞书 wechat：企业微信 dingding：钉钉
notify_lark_webhooks	Array of String	[]	飞书通知webhook列表。
notify_groups	Array of Long	287	邮件接收组id列表
notify_wechat_webhooks	Array of String	[]	企业微信通知webhook列表。
notify_dingding_webhooks	Array of String	[]	钉钉通知webhook列表。

StrategyResultList

Measure

参数	类型	示例值	描述
type	String	monomial	指标类型。 monomial：普通指标 polynomial：复合指标
raw_measure_list	Array of RawMeasureList	-	报警指标列表。
formula	String	-	指标四则运算公式。当指标类型为复合指标polynomial时选填。
name	String	慢页面次数	指标名。当指标为普通指标时为指标名，指标为复合指标时为自定义指标名。

参数	类型	示例值	描述
op	String	in	条件符号。 in not_in Regex not_regex
filter_name	String	browser_brand	筛选条件key。调用GetAlarmMetricRelatedMeta接口查看取值。用于表明filter的那个维度
values	Array of String	["Chrome"]	筛选条件值。调用GetAlarmMetricCandidate接口查看取值。

GroupResultList

参数	类型	示例值	描述
is_alarm	Boolean	true	是否报警。
group_value	String	-	分组报警取值，比如国家分组的中国，如果不是分组报警则不返回。
alarm_tag_list	Array of AlarmTagList	-	报警列表标签。
is_spike	Boolean	false	是否尖刺过滤。

RawMeasureList

参数	类型	示例值	描述
measure_name	String	slow_load_count	简单指标key。
filter_list	Array of FilterList	[]	筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。
event_name	String	-	自定义事件key。当指标为自定义事件指标时必填。

AlarmTagList

返回示例

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。