获取报警归因信息。

请求说明

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

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

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	MiniProAlarmAttribution	接口名称。当前 API 的名称为 MiniProAlarmAttribution。
Version	String	是	2024-03-12	接口版本。当前 API 的版本为 2024-03-12。
common	Object of Common	是	-	通用参数。
alarm_param	Object of AlarmParam	是	-	报警任务参数列表。
group_by_value	String	否	Chrome Webview	归因维度key。调用GetAlarmMetricRelatedMeta接口查看取值。
strategy_id	Integer	否	0	报警策略下标。表示归因的策略在alarm_param.strategy_list中的下标值。
attribution_time	Long	否	1666012500	报警归因终止时间。归因时间范围为[alarm_attribution_time-alarm_window_size*60, alarm_attribution_time]。

Common

AlarmParam

参数	类型	是否必选	示例值	描述
id	Long	否	1	报警任务ID。
name	String	是	test	报警任务名称。
desc	String	是	-	报警说明。
is_close	Integer	否	0	是否关闭报警。 0：开启 1：关闭
category	String	是	-	报警类别key。调用由GetAlarmMeta接口查看取值。 data.measure_category_meta_list[i].key
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	是否屏蔽尖刺报警。
pct_avoid_spike	Object of PctAvoidSpike	否	-	PCT报警。当开启PCT报警屏蔽时必填。

StrategyList

参数	类型	是否必选	示例值	描述
measure	Object of Measure	否	-	指标集合。
filter_list	Array of FilterList	否	-	报警策略筛选条件。
alarm_strategy_type	String	否	threshold	报警策略类型。 threshold：阈值报警 cmp_last_n_day：比值报警
daily_compare_count	Integer	否	5	同比支持过去x天，为1使用昨天，7表示上周同一天
alarm_threshold	Double	否	10	报警阈值。
threshold_cmp_op	String	否	gt	策略符号。可选值为比值报警时，取值为gt、lt 可选值为阈值报警时，取值为lt、lte、gt、gte
alarm_user_threshold	Double	否	1	用户数阈值。
alarm_sample_threshold	Double	否	1	样本数量阈值。
alarm_window_size	Long	否	180	报警任务查询时间窗口，表示最近X分钟。单位为分钟。
group_bys	Array of GroupBys	否	-	报警的分组维度。
attribution_dimensions	Array of AttributionDimensions	否	-	报警归因维度。

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	否	[ 291 ]	飞书通知webhooks列表。当报警通知方式包含飞书时必填。
notify_groups	Array of Long	否	[]	报警通知邮件组ID列表。当报警通知方法包含邮件时必填。
notify_wechat_webhooks	Array of String	否	[]	企微通知webhooks列表。当报警通知方式包含企微时必填。
notify_dingding_webhooks	Array of String	否	[]	钉钉通知webhooks列表。当报警通知方式包含钉钉时必填。

PctAvoidSpike

参数	类型	是否必选	示例值	描述
pct	Integer	否	1	报警子窗口值。可选值为1~9。当超过(含)X个子窗口的报警指标值超过设定的报警阈值时，才触发报警。

Measure

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

参数	类型	是否必选	示例值	描述
op	String	否	in	条件符号。 in not_in Regex not_regex
filter_name	String	否	browser_brand	筛选条件key。调用GetAlarmMetricRelatedMeta接口查看取值。
values	Array of String	否	["Chrome"]	筛选条件值。调用GetAlarmMetricCandidate接口查看取值。

GroupBys

参数	类型	是否必选	示例值	描述
label	String	否	pid	分组指标。
group_by_number_terms	Array of GroupByNumberTerms	否	pid	分组维度key。调用GetAlarmMetricRelatedMeta接口查看取值。

AttributionDimensions

参数	类型	是否必选	示例值	描述
label	String	否	pid	归因指标。
group_by_number_terms	Array of GroupByNumberTerms	否	pid	归因维度key。调用GetAlarmMetricRelatedMeta接口查看取值。

RawMeasureList

参数	类型	是否必选	示例值	描述
measure_name	String	否	pv_uv.count	简单指标key。调用GetAlarmMeta和GetAlarmEventMetaMetric接口查看取值。
filter_list	Array of FilterList	否	-	筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。
event_name	String	否	-	自定义事件key。当指标为自定义事件指标时必填。

GroupByNumberTerms

请求示例

返回参数

参数	类型	示例值	描述
data	Array of Data	-	返回数据。每个归因维度会有一个AlarmAttribution。
error_msg	String	-	错误信息。
error_no	Integer	0	错误码。0为成功。

Data

参数	类型	示例值	描述
alarm_category	String	performance	报警任务类型。
attribution_dimension	String	pid	当前归因的维度。
attribution_dimension_label	String	TOP pid	当前归因的维度名称。
detail_list	Array of DetailList	-	按归因维度group后的top3。

DetailList

返回示例

错误码

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