查看报警列表。

请求说明

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

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

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	PCAlarmRuleList	接口名称。当前 API 的名称为 PCAlarmRuleList。
Version	String	是	2022-10-28	接口版本。当前 API 的版本为 2022-10-28。
common	Object of CommonParams	是	-	通用参数。
status	Integer	否	0	监控状态。 0：status_open 1：status_close
self	Integer	否	1	管理状态。 0：全部不传 1：我管理的
category_list	Array of String	否	[pc_crash]	报警类型。 pc_flexible pc_crash
keyword	String	否	alarm	搜索名称关键字。
page_size	Integer	是	3	每页规则数。
page_num	Integer	是	1	返回页码号。

CommonParams

请求示例

返回参数

AlarmRuleList

参数	类型	示例值	描述
count	Integer	30	报警规则总数。
alarm_rule_list	Array of AlarmDetail	[ {"alarm_param":{...},"created_by": "root", "updated_by": "root" },...]	报警规则列表。

AlarmDetail

参数	类型	示例值	描述
created_by	String	zhangsan	创建人。
updated_by	String	lisi	更新人。
alarm_param	Object of AlarmParam	{id: 285, name: "lc测试", desc: "测试报警参数", is_close: 0, category: "pc_crash_sink_chtb",…}	报警配置。
created_time	Long	1667550612	创建时间。
updated_time	Long	1667550612	更新时间。
ack_until_time	Long	1667550612	ACK到期时间。
last_execute_time	Long	1668550612	上次执行时间。
next_trigger_time	Long	1667550612	下次触发时间。
num_of_alarm_in_last_one_month	Integer	1	上个月触发次数。

AlarmParam

AlarmPeriod

NotifyConfig

参数	类型	示例值	描述
notify_types	Array of String	["mail"]	报警通知方式。 lark mail wechat dingding
notify_groups	Array of Long	[1,23]	邮件接收组ID列表。
upgrade_groups	Array of Long	[1,23]	升级邮件接收组ID列表。
notify_lark_webhooks	Array of String	["http://lark/url"]	飞书通知webhook列表。
notify_wechat_webhooks	Array of String	["http://wechat/url"]	企业微信通知webhook列表。
notify_dingding_webhooks	Array of String	["http://dingding/url"]	钉钉通知webhook列表。

AlarmStrategy

参数	类型	示例值	描述
id	String	9018754602-1655285699772	当新建报警策略的时候前端生成，用于后端画趋势图。
measure	Object of FlexMeasure	-	指标集合。
group_bys	Array of FlexGroupBy	-	报警的分组。
filter_list	Array of FlexFilter	-	过滤条件。
alarm_threshold	Double	10	报警阈值。
threshold_cmp_op	String	gt	报警阈值的op。 gt gte lt lte abs_gt abs_gte
alarm_window_size	Long	180	时间窗口，单位s。
alarm_strategy_type	String	threshold	指标计算策略。阈值：threshold 同比：cmp_last_n_day
daily_compare_count	Integer	60	同比支持过去x分钟。
alarm_sample_threshold	Double	3	样本数量阈值。

FlexMeasure

FlexGroupBy

FlexFilter

FlexRawMeasure

参数	类型	示例值	描述
event_name	String	test_service_gyf	前端传了此参数, 后端没有用到。但是还原图表的时候是从这个字段读的事件名。
filter_list	Array of FlexFilter	-	过滤条件。
measure_name	String	"{"metric":"pc_flexible.count","event_dimension":"pc_flexible.event_name","event_name":"test_service_gyf"}"	具体的指标计算值。

返回示例

错误码

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