Query a list of alerts.

Request description

RUM is deployed across multiple regions worldwide to provide more stable and low-latency access. You can refer to the Service addresses topic to choose the most suitable access point based on your business location.

Request method: POST

Request URL: https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=PCAlarmRuleList&Version=2022-10-28

Request parameters

The following table lists only the request parameters specific to this API and some public parameters. For details, see Public parameters.

Parameters	Type	Required	Sample value	Description
Action	String	Yes	PCAlarmRuleList	The API name. The API name is PCAlarmRuleList.
Version	String	Yes	2022-10-28	The API version. The current API version is 2022-10-28.
common	Object of CommonParams	Yes	-	Public parameters.
status	Integer	No	0	Monitoring status. 0：status_open 1：status_close
self	Integer	No	1	Management status. 0: All unpassed 1: Managed by me
category_list	Array of String	No	[pc_crash]	The alert type. pc_flexible pc_crash
keyword	String	No	alarm	Search keyword.
page_size	Integer	Yes	3	The number of rules per page.
page_num	Integer	Yes	1	Returned page number.

CommonParams

Parameters	Type	Required	Sample value	Description
os	String	Yes	pc	Operating system.
aid	Long	Yes	12345	App ID.
env	String	No	crash	Environment information.

Sample request

Response parameters

Parameters	Type	Sample value	Description
data	Object of AlarmRuleList	-	Response data.
errmsg	String	""	Error message. If the request was successful, this field is empty.
errno	Integer	200	Error code. If the request was successful, this field is 200.

AlarmRuleList

Parameters	Type	Sample value	Description
count	Integer	30	Total alert rule count.
alarm_rule_list	Array of AlarmDetail	[ {"alarm_param":{...},"created_by": "root", "updated_by": "root" },...]	A list of alert rules.

AlarmDetail

Parameters	Type	Sample value	Description
created_by	String	zhangsan	The creator.
updated_by	String	lisi	The updater.
alarm_param	Object of AlarmParam	{id: 285, name: "lctest", desc: "alert_parameter_paras", is_close: 0, category: "pc_crash_sink_chtb",…}	The alert configuration.
created_time	Long	1667550612	Creation time.
updated_time	Long	1667550612	Update time.
ack_until_time	Long	1667550612	ACK expiration time.
last_execute_time	Long	1668550612	The last execution time.
next_trigger_time	Long	1667550612	The next trigger time.
num_of_alarm_in_last_one_month	Integer	1	The number of alerts triggered last month.

AlarmParam

Parameters	Type	Sample value	Description
id	Long	1	The parameter is not required during creation and is required during update.
desc	String	New alert	Alert description.
name	String	minitor	The alert name.
category	String	pc_flexible	The alert type.
is_close	Integer	1	Whether to disable alerts. 0: Enabled 1: Disabled
alarm_level	String	Warn	The alert level. Notice Warn Fatal
strategy_op	String	and	The multiple-policy logic. and or
alarm_period	Object of AlarmPeriod	-	The alert time period.
notify_config	Object of NotifyConfig	-	The alert notification.
strategy_list	Array of AlarmStrategy	-	Alert policy.
category_label	String	""	Alert type display name.
interval_seconds	Integer	300	The alerting interval. The minimum interval is 5 minutes.

AlarmPeriod

Parameters	Type	Sample value	Description
end_time	Integer	86399	The end time of alerting, in seconds.
start_time	Integer	0	The start time of alerting, in seconds.

NotifyConfig

Parameters	Type	Sample value	Description
notify_types	Array of String	["mail"]	The alert notification method. lark mail wechat dingding
notify_groups	Array of Long	[1,23]	A list of mail receiver group IDs.
upgrade_groups	Array of Long	[1,23]	A list of elevated email receiver group IDs.
notify_lark_webhooks	Array of String	["http://lark/url"]	A list of Feishu notification webhooks.
notify_wechat_webhooks	Array of String	["http://wechat/url"]	A list of WeCom notification webhooks.
notify_dingding_webhooks	Array of String	["http://dingding/url"]	A list of DingTalk notification webhooks.

AlarmStrategy

Parameters	Type	Sample value	Description
id	String	9018754602-1655285699772	The parameter value is generated by the frontend when a new alert policy is created. This parameter value is used by the backend to plot trend charts.
measure	Object of FlexMeasure	-	The metric set.
group_bys	Array of FlexGroupBy	-	Alert grouping.
filter_list	Array of FlexFilter	-	Filter condition.
alarm_threshold	Double	10	The alert threshold.
threshold_cmp_op	String	gt	The operator for the alert threshold. gt gte lt lte abs_gt abs_gte
alarm_window_size	Long	180	The time window in seconds.
alarm_strategy_type	String	threshold	The metric calculation policy. For a threshold policy, the value is "threshold". For a period-over-period policy, the value is "cmp_last_n_day".
daily_compare_count	Integer	60	Period-over-period comparison now supports the past X minutes.
alarm_sample_threshold	Double	3	Sample count threshold.

FlexMeasure

Parameters	Type	Sample value	Description
name	String	crash_affected_users	The metric name.
type	String	monomial	Metric type. monomial polynomial
customId	String	xe3ejx98	Used by the frontend to restore the page.
raw_measure_list	Array of FlexRawMeasure	-	Specific query metrics.

FlexGroupBy

Parameters	Type	Sample value	Description
label	String	OS	The displayed group name.
group_by_name	String	os	The grouping dimension.

FlexFilter

Parameters	Type	Sample value	Description
op	String	in	Filtering method.
values	Array of String	["intel", "Qualcomm"]	Filter values.
filter_name	String	cpu	Indicates the dimension of the filter.

FlexRawMeasure

Parameters	Type	Sample value	Description
event_name	String	test_service_gyf	This parameter is passed by the frontend but not used by the backend. However, when the system restores the chart, it reads the event name from this field.
filter_list	Array of FlexFilter	-	Filter condition.
measure_name	String	"{"metric":"pc_flexible.count","event_dimension":"pc_flexible.event_name","event_name":"test_service_gyf"}"	Value calculated for a specific metric.

Sample response

Error codes

No error codes are specific to this API. If the API call returns an error code, refer to Public error codes for troubleshooting.

Application Performance Management Plus