Get app alert task list.

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=GetAppAlarmRuleList&Version=2025-12-01

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	GetAppAlarmRuleList	The API name. The current API name is GetAppAlarmRuleList.
Version	String	Yes	2025-12-01	The API version. The API version is 2025-12-01.
Aid	Long	No	123456	The app ID.
RuleId	Long	No	1	Alert task ID.
MonitorType	String	No	["crash"]	The exception type. Values: crash: Crash crash_defend: Crash protection lag: Lag flutter_crash: Flutter monitoring app_page_js_err: Page monitoring / JS error app_page_ajax_err: Page monitoring / Request error app_page_perf: Page monitoring / Performance app_event: Event alert net_err: Network error custom_exception: Custom error
MonitorTypes	Array of String	No	["crash","lag"]	Exception type list. Values: crash: Crash crash_defend: Crash protection lag: Lag flutter_crash: Flutter monitoring app_page_js_err: Page monitoring / JS error app_page_ajax_err: Page monitoring / Request error app_page_perf: Page monitoring / Performance app_event: Event alert net_err: Network error custom_exception: Custom error
Status	Array of Integer	Yes	[1,2]	Task status list. Values: 1: Enable 2: Disable
QueryKey	String	Yes	test	Search keyword. You can search by configuration or receiver group keyword.
PageSize	Long	Yes	2	Number of items per page. Defaults to 10 if not specified.
PageNo	Long	Yes	1	Start page number, which starts from 1.
Self	Integer	Yes	0	Whether to only view rules created by yourself. Values: 1: Only view your own 0: View all

Sample request

Response parameters

Parameters	Type	Sample value	Description
Data	Array of AlarmRule	-	Alert task list.
CurrPage	Long	1	Current page number.
TotalCnt	Long	1	The total number of items.
TotalPage	Long	1	Total page count.

AlarmRule

Parameters	Type	Sample value	Description
Id	Long	1	Alert rule ID. It can be omitted when creating a new rule.
Os	String	iOS	The operating system.
Name	String	task_test	Rule name.
Brief	String	-	Rule overview information.
Count	Long	1	Alert count.
Filter	Object of FilterCondition	-	Alert metric filter criteria.
Status	Integer	0	Alert status. Values: 1: Enable 2: Disable 0: Delete
AckTime	String	2006-01-02 15:04:05	Ack time.
HitRule	Object of AlarmHitRule	-	Alert trigger condition.
OwnerId	Long	123456	Rule owner ID.
GroupBys	Array of GroupBy	-	Alert grouping condition.
UpdateAt	String	2006-01-02 15:04:05	The time when the event was updated, in the format "yyyy-MM-dd HH:mm:ss".
AckStatus	Integer	0	ACK status. Values: 0: Not ACKed 1：ACK
OwnerInfo	Object of UserProfile	-	Rule owner information.
AlarmLevel	String	warning	Alert level, with enumerated values: "warning" and "fatal"
CheckCycle	Long	5	Monitoring period. 0 for instant alerts, in minutes.
NoticeConf	Object of AlarmNoticeConf	-	Notification configuration information.
Activations	Array of Activation	-	Multiple effective time periods.
CallbackUrl	String	https://www.baidu.com	Callback URL.
Description	String	alarm for xxx	Rule description.
MonitorType	String	crash	The exception type. Values: crash: Crash crash_defend: Crash protection lag: Lag flutter_crash: Flutter monitoring app_page_js_err: Page monitoring / JS error app_page_ajax_err: Page monitoring / Request error app_page_perf: Page monitoring / Performance app_event: Event alert net_err: Network error custom_exception: Custom error
ActivationEnd	String	23:00	Start of all-day effective time, 24-hour format, accurate to the minute. For example, 9 AM is "09:00".
ActivationStart	String	08:00	End of all-day effective time, 24-hour format, accurate to the minute. For example, 9:00 PM is "21:00".
RecentlyOccurTime	String	-	The latest occurrence time. Empty string if not occurred.

FilterCondition

Parameters	Type	Sample value	Description
Op	String	in	The operator. Values: gt: greater than gte: greater than or equal to lt: less than lte: less than or equal to eq: equal to neq: not equal to in: contains not_in: does not contain lk: Matches data that fits a specific pattern. nlk: Excludes data that fits a specific pattern.
Type	String	and	Condition type. Sample value: expression: The current condition is a single expression. and: The current condition is a compound expression, and the sub-conditions in SubConditions are in a logical AND relationship. or: The current condition is a compound expression, and the sub-conditions in SubConditions are in a logical OR relationship.
Value	String	123456	Single operand.
Values	Array of String	[123456]	Operand list.
Dimension	String	aid	Condition dimension name.
SubCondition	Object of FilterCondition	-	The sub-condition.
SubConditions	Array of FilterCondition	-	Sub-condition list.

AlarmHitRule

Parameters	Type	Sample value	Description
Op	String	gt	The comparator. Values: gt: greater than gte: greater than or equal to lt: less than lte: less than or equal to eq: equal to
Type	String	and	The type of the filter condition. Sample value: expression: The current condition is a single expression. and: The current condition is a compound expression, and the sub-conditions in SubConditions are in a logical AND relationship. or: The current condition is a compound expression, and the sub-conditions in SubConditions are in a logical OR relationship.
Indicator	Object of Indicator	-	Threshold-type metric configuration.
Indicators	Array of Indicator	-	Year-over-year and period-over-period metric configuration.
SubHitRule	Object of AlarmHitRule	-	Sub-rule.
HitRuleType	String	threshold	Matched rule type. Values: threshold: Threshold compare: Year-over-year and period-over-period comparison
SubHitRules	Array of AlarmHitRule	-	Sub-rule list.
ThresholdValue	Double	10,000	Alert threshold.
ThresholdCalculateType	String	-	Threshold calculation method, supporting addition/subtraction or percentage.

GroupBy

Parameters	Type	Sample value	Description
Dimension	String	path	Group name.

UserProfile

Parameters	Type	Sample value	Description
Id	Long	1	The user ID.
Email	String	test@test.com	User email
Username	String	test_name	User name.
SsoUserId	String	123456	SSO user ID.

AlarmNoticeConf

Parameters	Type	Sample value	Description
Type	Array of String	mail	Notification type. lark: Feishu mail: Email dingding: DingTalk wechat: WeCom
LarkAtConf	Object of AtConf	-	Feishu @ configuration
LarkWebHooks	Array of String	-	Feishu Webhook address list
WechatAtConf	Object of AtConf	-	WeCom @ configuration.
AlarmReceives	Array of Candidate	-	Alert recipient/receiver group.
TitleTemplate	String	-	Alert title template, which may contain special characters.
DingdingAtConf	Object of AtConf	-	DingTalk @ configuration.
WechatWebHooks	Array of String	-	WeCom webhook address list.
ContentTemplate	String	-	Alert content template, which may contain special characters.
DingdingWebHooks	Array of String	-	DingTalk webhook address list.

Activation

Parameters	Type	Sample value	Description
ActivationEnd	String	23:00	End of effective time, 24-hour format, accurate to the minute. For example, 9:00 PM is "21:00".
ActivationStart	String	08:00	Start of effective time, 24-hour format, accurate to the minute. For example, 9 AM is "09:00".
ActivationEndStamp	Long	1665417900	Effective period end timestamp.
ActivationStartStamp	Long	1665417600	Effective period start timestamp.

Indicator

Parameters	Type	Sample value	Description
Name	String	crash_count	Metric definition name, obtained via the GetAppAlarmMetricsConf API.
Value	Double	10	The metric value.
EndTime	Long	1665417900	Statistics end time.
Recently	Long	180	Metric query time range, in minutes.
StartTime	Long	1665417600	Timestamp of the statistics start time.
CompareTime	Long	0	Comparison time. Values: 5: Previous five minutes 0: Current

AtConf

Parameters	Type	Sample value	Description
IdType	String	mobile	ID type. Values: mobile userid openid
IdValues	Array of String	["123"]	List of IDs to be @mentioned.

Candidate

Parameters	Type	Sample value	Description
Email	String	test@test.com	User email
GroupId	Integer	123	Receiver group ID.
IsGroup	Boolean	true	Whether it is a receiver group. Values: true: It is a receiver group. false: It is not a receiver group.
UserName	String	test	User name.
GroupName	String	test	Receiver group name.

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