Update alert task.

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=UpdateAlarm&Version=2022-10-12

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	UpdateAlarm	The API name. The current API name is UpdateAlarm.
Version	String	Yes	2022-10-12	The API version. The current API version is 2022-10-12.
common	Object of Common	No	-	Common parameters.
alarm_param_list	Array of AlarmParamList	No	-	Alert task parameter list.

Common

Parameters	Type	Required	Sample value	Description
aid	Long	No	12345	Application ID.
os	String	No	webpro	Service type.

AlarmParamList

Parameters	Type	Required	Sample value	Description
name	String	No	test	Alert task name.
desc	String	No	-	Alert description.
is_close	Integer	No	0	Whether to disable alerts. 0: Enable 1: Disable
category	String	No	pageview	Alert type key. Call the GetAlarmMeta API to view available values.
alarm_level	String	No	warning	Alert level. warning fatal
strategy_list	Array of StrategyList	No	-	Alert policy list.
strategy_op	String	No	and	Alert multi-policy relationship. and: Satisfy all policies simultaneously or: Satisfy any policy
interval_seconds	Integer	No	300	Alert task execution interval. 300: 5 minutes 600: 10 minutes 1800: 30 minutes 3600: 60 minutes
alarm_period	Object of AlarmPeriod	No	-	Alert effective time. Alerts outside the time range will not trigger notifications.
notify_config	Object of NotifyConfig	No	-	Alert task notification configuration.
is_avoid_spike	Boolean	No	false	Alert optimization. It determines whether to silence spike alerts.
pct_avoid_spike	Object of PctAvoidSpike	No	-	pct alert parameter. It is required when pct alert silence is enabled.

StrategyList

Parameters	Type	Required	Sample value	Description
measure	Object of Measure	No	-	The metric list.
filter_list	Array of FilterList	No	-	Alert policy filter criteria.
alarm_strategy_type	String	No	threshold	Alert policy type. threshold: Threshold-based alert cmp_last_n_day: Difference-based alert
daily_compare_count	Integer	No	5	Time interval between the previous period and the current period. This parameter is required when the alert policy is difference-based. The unit is minutes. For example, 1440 sets the comparison offset to 1 day ago.
alarm_threshold	Double	No	10	Alert threshold.
threshold_cmp_op	String	No	gt	Policy operator. Valid values for difference-based alerts: gt and lt Valid values for threshold-based alerts: lt, lte, gt, and gte
alarm_user_threshold	Double	No	1	User count threshold.
alarm_sample_threshold	Double	No	1	Sample count threshold.
alarm_window_size	Long	No	180	Time window for alert task query. It represents the last X minutes. The unit is minutes.
group_bys	Array of GroupBys	No	-	Alert grouping dimension.
attribution_dimensions	Array of AttributionDimensions	No	-	Alert attribution dimensions.

AlarmPeriod

Parameters	Type	Required	Sample value	Description
start_time	Integer	No	0	Alert start time. The value is the start timestamp in seconds relative to 0:00 of the current day. For example, if the start time is 2:00 on the current day, the value is 7200.
end_time	Integer	No	86399	Alert end time. The value is the end timestamp in seconds relative to 0:00 of the current day. For example, if the end time is 23:59:59 on the current day, the value is 86399.

NotifyConfig

Parameters	Type	Required	Sample value	Description
notify_types	Array of String	No	[ "mail" ]	The alert notification method. mail: Email lark: Feishu wechat: WeCom dingding: DingTalk
notify_lark_webhooks	Array of String	No	[]	List of Feishu notification webhooks. Required when the alert notification method includes Feishu.
notify_groups	Array of Long	No	[ 291 ]	List of alert notification email group IDs. Required when the alert notification method includes email.
notify_wechat_webhooks	Array of String	No	[]	A list of WeCom notification webhooks. Required when the alert notification method includes WeCom.
notify_dingding_webhooks	Array of String	No	[]	List of DingTalk notification webhooks. Required when the alert notification method includes DingTalk.

PctAvoidSpike

Parameters	Type	Required	Sample value	Description
pct	Integer	No	1	Alert sub-window value. Available values: 1 to 9. The alert is triggered only when the alert metric values of X or more sub-windows exceed the configured alert threshold.

Measure

Parameters	Type	Required	Sample value	Description
type	String	No	monomial	Metric type. monomial: Simple metric polynomial: Composite metric
raw_measure_list	Array of RawMeasureList	No	-	The set of all metrics.
formula	String	No	-	Metric arithmetic formula. This parameter is optional when the metric type is polynomial.
name	String	No	PV	The metric name. When the metric is a simple metric, it is the metric name. When the metric is a composite metric, it is the custom metric name.

Parameters	Type	Required	Sample value	Description
op	String	No	in	Condition operator. in: contains not_in: does not contain Regex: Regex match not_regex: Regex mismatch
filter_name	String	No	browser_brand	Filter criterion key. Call the GetAlarmMetricRelatedMeta API to view available values.
values	Array of String	No	["Chrome"]	Filter criterion values. Call the GetAlarmMetricCandidate API to view available values.

GroupBys

Parameters	Type	Required	Sample value	Description
group_by_name	String	No	pid	Grouping dimension key. Call the GetAlarmMetricRelatedMeta API to view available values.
label	String	No	pid	Grouping metric.

AttributionDimensions

Parameters	Type	Required	Sample value	Description
group_by_name	String	No	pid	Attribution dimension key. Call the GetAlarmMetricRelatedMeta API to view available values.
label	String	No	pid	Attribution metric.

RawMeasureList

Parameters	Type	Required	Sample value	Description
measure_name	String	No	pv_uv.count	Simple metric key. Call the GetAlarmMeta and GetAlarmEventMetaMetric APIs to view available values.
filter_list	Array of FilterList	No	-	The filter condition. Optional when a single simple metric carries criteria and the metric type is composite.
event_name	String	No	-	Custom event key. Required when the metric is a custom event metric.

Sample request

Response parameters

Parameters	Type	Sample value	Description
data	String	-	Response data.
error_msg	String	""	Error message. An empty string "" indicates success.
error_no	Integer	0	Error code. 0 indicates success.

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