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

请求说明

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

请求方式：POST

请求地址：https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAlarmHistory&Version=2022-10-12

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	GetAlarmHistory	接口名称。当前 API 的名称为 GetAlarmHistory。
Version	String	是	2022-10-12	接口版本。当前 API 的版本为 2022-10-12。
common	Object of Common	否	-	通用参数。
id	Long	否	302	报警任务ID列表。
page_size	Integer	否	30	分页查询参数，用于设置每页行数。默认值：30。
page_num	Integer	否	1	分页查询参数，用于设置当前页码。默认值：1。
time_filter	Object of TimeFilter	否	-	时间区间。

Common

参数	类型	是否必选	示例值	描述
aid	Long	否	12345	应用ID。
os	String	否	webpro	服务类型。

TimeFilter

参数	类型	是否必选	示例值	描述
start_time	Integer	否	1665849600	起始时间。
granularity	Integer	否	60	聚合时间粒度。
end_time	Integer	否	1666011403	终止时间。

请求示例

返回参数

参数	类型	示例值	描述
data	Object of Data	-	返回内容。
error_msg	String	""	错误信息。成功为""。
error_no	Integer	0	错误码。成功为0。

Data

参数	类型	示例值	描述
alarm_histories	Array of AlarmHistories	-	报警趋势。
count	Integer	1	报警数。

AlarmHistories

参数	类型	示例值	描述
id	Long	160570	报警历史ID。
alarm_param	Object of AlarmParam	-	报警参数。
alarm_time	Long	1666011480	报警发生时间。
alarm_content	String	-	报警内容。
alarm_result	Object of AlarmResult	-	报警结果。
operator	String	bytedance-apm	报警任务创建人。
detail_link	String	/apmplus/webpro/data_search?aid=12345&end_time=1666011480&ev_type=view&start_time=1666000680	报警详情链接。

AlarmParam

参数	类型	示例值	描述
id	Long	302	报警任务ID。
name	String	jiyi-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	5	报警阈值。
threshold_cmp_op	String	gt	报警阈值的策略符号。可选值为比值报警时，取值为gt、lt 可选值为阈值报警时，取值为lt、lte、gt、gte
alarm_user_threshold	Double	0	用户数阈值。
alarm_sample_threshold	Double	0	样本量阈值。
alarm_window_size	Long	180	报警任务查询时间窗口，表示最近X分钟。单位为分钟。
sample_metric	Object of SampleMetric	-	示例指标。
user_metric	Object of UserMetric	-	用户指标。

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_groups	Array of Long	287	报警通知邮件组ID列表。当报警通知方法包含邮件时必填。

StrategyResultList

参数	类型	示例值	描述
is_alarm	Boolean	true	是否满足策略条件。
title	String	慢页面次数阈值报警	查询结果的标题。
is_attributable	Boolean	false	是否归因。
group_result_list	Array of GroupResultList	-	报警分组结果。

Measure

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

参数	类型	示例值	描述
op	String	-	筛选条件和筛选值之间的关系。
filter_name	String	-	筛选指标名称。
values	Array of String	-	筛选指标的取值。

SampleMetric

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

UserMetric

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

GroupResultList

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

RawMeasureList

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

AlarmTagList

参数	类型	示例值	描述
label	String	当前值	指标。
value	Double	1172	当前指标的取值。
format_value	String	1172	格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

AlarmValue

参数	类型	示例值	描述
current_value	Object of CurrentValue	-	当前值。
alarm_threshold	Object of AlarmThreshold	-	报警阈值。
sample_count	Object of SampleCount	-	样本量。
user_count	Object of UserCount	-	用户量。
window_size	Object of WindowSize	-	时间窗口。

CurrentValue

参数	类型	示例值	描述
label	String	当前值	指标。
value	Double	1174	当前指标的取值。
format_value	String	-	格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

AlarmThreshold

参数	类型	示例值	描述
label	String	当前值	指标。
value	Double	1174	当前指标的取值。
format_value	String	-	格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

SampleCount

参数	类型	示例值	描述
label	String	当前值	指标。
value	Double	1174	当前指标的取值。
format_value	String	-	格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

UserCount

参数	类型	示例值	描述
label	String	当前值	指标。
value	Double	1174	当前指标的取值。
format_value	String	-	格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

WindowSize

参数	类型	示例值	描述
label	String	当前值	指标。
value	Double	1174	当前指标的取值。
format_value	String	-	格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

返回示例

错误码

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

应用性能监控全链路版