Help Center/ Application Operations Management/ API Reference/ APIs/ Alarm/ Adding or Modifying Metric or Event Alarm Rules

Updated on 2026-10-22 GMT+08:00

View PDF

Adding or Modifying Metric or Event Alarm Rules

Function

This API is used to add or modify AOM 2.0 metric or event alarm rules.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
aom:alarmRule:create	Write	alarmRule *	g:ResourceTag/<tag-key>	-	-
aom:alarmRule:create	Write	-	g:TagKeys g:RequestTag/<tag-key>	-	-

URI

POST /v4/{project_id}/alarm-rules

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
action_id	Yes	String	Alarm rule ID. To add an alarm rule, enter add-alarm-action. To modify an alarm rule, enter update-alarm-action.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. For details, see Obtaining a Token.
Content-Type	Yes	String	Message body type or format. Content type, which is application/json.
Enterprise-Project-Id	No	String	Enterprise project ID. For details, see Obtaining an Enterprise Project ID. To query the instances in an enterprise project, enter the enterprise project ID. To query the instances in all enterprise projects, enter all_granted_eps.

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
alarm_notifications	No	AlarmNotification object	Alarm notification module.
alarm_rule_description	No	String	Alarm rule description.
alarm_rule_enable	No	Boolean	Enabled or not.
alarm_rule_name	Yes	String	Alarm rule name.
alarm_rule_type	Yes	String	Alarm rule type. metric: metric alarm rule event: event alarm rule
event_alarm_spec	No	EventAlarmSpec object	Structure of an event alarm rule.
metric_alarm_spec	No	MetricAlarmSpec object	Structure of a metric alarm rule.
prom_instance_id	No	String	Prometheus instance ID.
alias	No	String	Alias of an alarm rule. Enter a maximum of 256 characters and do not start or end with any special character. Only letters, digits, underscores (_), and hyphens (-) are allowed.

**Table 5** AlarmNotification
Parameter	Mandatory	Type	Description
notification_type	Yes	String	Notification type. direct: direct alarm reporting alarm_policy: alarm reporting after noise reduction
route_group_enable	Yes	Boolean	Whether to enable the alarm grouping rule. If the notification type is set to alarm_policy, set this parameter to true. If the notification type is set to direct, set this parameter to false. If both notify_triggered and notify_resolved are set to false, route_group_enable must be set to false.
route_group_rule	Yes	String	Alarm grouping rule name. If route_group_enable is set to true, enter an alarm grouping rule name. If route_group_enable is set to false, enter "".
notification_enable	No	Boolean	Whether to enable the alarm notification rule. If the notification type is direct, set this parameter to true. If the notification type is alarm_policy, set this parameter to false. If both notify_triggered and notify_resolved are set to false, notification_enable must be set to false.
bind_notification_rule_id	No	String	Alarm action rule ID. If notification_enable is set to true, enter an alarm action rule ID. If notification_enable is set to false, enter "".
notify_resolved	No	Boolean	Whether to send a notification when an alarm is cleared. true: Send a notification. false: Do not send any notification.
notify_triggered	No	Boolean	Whether to send a notification when an alarm is triggered. true: Send a notification. false: Do not send any notification.
notify_frequency	No	Integer	Notification frequency. If the notification type is alarm_policy, set this parameter to -1. If the notification type is direct, set this parameter to any of the following: 0: alarm sent only once 300: every 5 minutes 600: every 10 minutes 900: every 15 minutes 1800: every 30 minutes 3600: every hour 10800: every 3 hours 21600: every 6 hours 43200: every 12 hours 86400: every day

**Table 6** EventAlarmSpec
Parameter	Mandatory	Type	Description
alarm_source	No	String	Alarm rule source. systemEvent customEvent
event_source	No	String	Alarm source. RDS EVS CCE LTS AOM
monitor_objects	No	Array of Map<String,String> objects	List of monitored objects. Key-value pair. event_type: notification type event_severity: alarm severity event_name: event name namespace: namespace clusterId: cluster ID customField: user-defined field
trigger_conditions	Yes	Array of EventTriggerCondition objects	Trigger conditions.
alarm_rule_template_bind_enable	No	Boolean	(Deprecated) Whether to bind an alarm rule template.
alarm_rule_template_id	No	String	(Deprecated) ID of the alarm rule template.

**Table 7** EventTriggerCondition
Parameter	Mandatory	Type	Description
event_name	No	String	Event name.
trigger_type	No	String	Trigger mode. immediately: An alarm is triggered immediately if the alarm condition is met. accumulative: An alarm is triggered if the alarm condition is met for a specified number of times.
aggregation_window	No	Long	Monitoring period. Unit: second. For example, 3600 indicates 1 hour. If trigger_type is set to immediately, leave this parameter blank. If trigger_type is set to accumulative, this parameter is mandatory. Value range: 5 minutes, 20 minutes, 1 hour, 4 hours, or 24 hours.
operator	No	String	Operator. Options: >, <, =, >=, and <=. If trigger_type is set to immediately, leave this parameter blank. If trigger_type is set to accumulative, this parameter is mandatory.
thresholds	No	Map<String,Integer>	Key-value pair. The key indicates the alarm severity while the value indicates the number of accumulated trigger times. If trigger_type is set to immediately, the value is 1. If trigger_type is set to accumulative, the value ranges from 1 to 100. (This parameter is mandatory if trigger_conditions is specified.)
frequency	No	String	Event alarm notification frequency. If trigger_type is set to immediately, the value of this parameter is -1. -1: N/A. 0: alarm sent only once. 300: every 5 minutes. 600: every 10 minutes. 900: every 15 minutes. 1800: every 30 minutes. 3600: every hour. 10800: every 3 hours. 21600: every 6 hours. 43200: every 12 hours. 86400: every day.

**Table 8** MetricAlarmSpec
Parameter	Mandatory	Type	Description
monitor_type	Yes	String	Monitoring type. all_metric: Select metrics from all metrics. promql: Select metrics using PromQL. resource (unavailable soon): Select metrics by resource type.
no_data_conditions	No	Array of NoDataCondition objects	Action taken for insufficient data.
alarm_tags	Yes	Array of AlarmTags objects	Alarm tags.
monitor_objects	No	Array of Map<String,String> objects	List of monitored objects.
recovery_conditions	Yes	RecoveryCondition object	Alarm clearance condition.
trigger_conditions	Yes	Array of TriggerCondition objects	Trigger conditions.
alarm_rule_template_bind_enable	No	Boolean	(Deprecated) Whether to bind an alarm rule template.
alarm_rule_template_id	No	String	(Deprecated) ID of the alarm rule template.

**Table 9** NoDataCondition
Parameter	Mandatory	Type	Description
no_data_timeframe	No	Integer	Number of consecutive periods without data. Value range: 1–5. (If notify_no_data is set to true, this parameter is mandatory. If notify_no_data is set to false, leave this parameter blank.)
no_data_alert_state	No	String	Status of the threshold rule when the data is insufficient. (If notify_no_data is set to true, this parameter is mandatory. If notify_no_data is set to false, leave this parameter blank.) no_data: A notification indicating insufficient data is sent. alerting: An alarm is triggered. ok: No exception occurs. pre_state: Retain the previous state.
notify_no_data	No	Boolean	Whether to take action when no data is reported. true: Enable the function. false: Disable the function.

**Table 10** AlarmTags
Parameter	Mandatory	Type	Description
auto_tags	No	Array of strings	Automatic tag.
custom_tags	No	Array of strings	Custom tag.
custom_annotations	No	Array of strings	Alarm annotation.

**Table 11** RecoveryCondition
Parameter	Mandatory	Type	Description
recovery_timeframe	No	Integer	Number of consecutive periods for which the trigger condition is not met to clear an alarm. Value range: 1–3. (If recovery_timeframe is specified, this parameter is mandatory.)

**Table 12** TriggerCondition
Parameter	Mandatory	Type	Description
metric_query_mode	Yes	String	Metric query mode. AOM: native AOM PROM: AOM Prometheus NATIVE_PROM: native Prometheus
metric_namespace	Yes	String	Metric namespace.
metric_name	Yes	String	Metric name.
metric_unit	Yes	String	Metric unit.
metric_labels	Yes	Array of strings	Metric dimension.
promql	Yes	String	Prometheus statement.
promql_expr	No	String	Prometheus statement template.
trigger_times	No	Integer	Number of consecutive periods.
trigger_interval	No	String	Check interval. If trigger_type is set to HOURLY, set this parameter to "". If trigger_type* is set to DAILY, set 00:00–23:00. Example: 03:00. If trigger_type is set to WEEKLY, select a day in a week and then select 00:00–23:00. Example: 1 03:00" indicates 03:00 on every Monday. If trigger_type is set to CRON, specify a standard cron expression. If trigger_type is set to FIXED_RATE, select 15s, 30s, 1–59 min, or 1–24 h. Example: 15s, 30s, 1min**, or 1h.
trigger_type	No	String	Trigger type. FIXED_RATE: fixed interval HOURLY: every hour DAILY: every day WEEKLY: every week CRON: Cron expression
promql_for	No	String	Native Prometheus monitoring duration.
aggregation_type	No	String	Definition: Statistics. Range: average minimum maximum sum sampleCount
operator	No	String	Operator. Options: >, <, =, >=, and <=.
thresholds	No	Map<String,String>	Key-value pair. The key indicates the alarm severity while the value indicates the alarm threshold.
aggregation_window	No	String	Statistical period. Options: 15s: 15 seconds. 30s: 30 seconds. 1m: 1 minute. 5m: 5 minutes. 15m: 15 minutes. 1h: 1 hour.
cmdb	No	CmdbInfo object	CMDB information.
query_match	No	String	Query filter criteria.
query_param	Yes	Object	Query parameter.
aom_monitor_level	No	String	Monitoring layer.
aggregate_type	No	String	Aggregation method. by: not grouped. avg: average value. max": maximum value. "min": minimum value. "sum": sum.
metric_statistic_method	No	String	Metric statistics method to be used when you set Configuration Mode to Select from all metrics during alarm rule setting. single: single metric mix: multi-metric combined operations
expression	No	String	Expression of a combined operation.
mix_promql	No	String	PromQL of a combined operation.

**Table 13** CmdbInfo
Parameter	Mandatory	Type	Description
app_id	No	String	Application ID.
node_ids	No	Array of NodeInfo objects	Node information list.

**Table 14** NodeInfo
Parameter	Mandatory	Type	Description
node_type	No	String	Node type.
node_id	No	String	Node ID.

Response Parameters

Status code: 200

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_message	String	Error message.
alarm_rules	Array of AddOrUpdateAlarmRuleV4ItemResult objects	Alarm rule list.

**Table 16** AddOrUpdateAlarmRuleV4ItemResult
Parameter	Type	Description
alarm_rule_name	String	Alarm rule name.
result	String	Whether an alarm rule is successfully added or modified.

Status code: 400

**Table 17** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error message. Range N/A
error_type	String	Definition Error type. Range N/A
trace_id	String	Definition Request ID. Range N/A

Status code: 500

**Table 18** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error message. Range N/A
error_type	String	Definition Error type. Range N/A
trace_id	String	Definition Request ID. Range N/A

Example Requests

Add a metric alarm rule.

https://{Endpoint}/v4/{project_id}/alarm-rules?action_id=add-alarm-action

{
  "alarm_notifications" : {
    "bind_notification_rule_id" : "",
    "notification_enable" : false,
    "notification_type" : "alarm_policy",
    "notify_frequency" : -1,
    "notify_resolved" : true,
    "notify_triggered" : true,
    "route_group_enable" : true,
    "route_group_rule" : "aom_route_group_rule"
  },
  "alarm_rule_description" : "aom_alarm_rule",
  "alarm_rule_enable" : true,
  "alarm_rule_name" : "aom_alarm_rule",
  "alarm_rule_type" : "metric",
  "metric_alarm_spec" : {
    "alarm_rule_template_bind_enable" : false,
    "alarm_rule_template_id" : "",
    "alarm_tags" : [ {
      "auto_tags" : [ ],
      "custom_annotations" : [ "333=rrr" ],
      "custom_tags" : [ "333=rrr" ]
    } ],
    "monitor_objects" : [ ],
    "monitor_type" : "all_metric",
    "no_data_conditions" : [ {
      "no_data_alert_state" : "no_data",
      "no_data_timeframe" : 3,
      "notify_no_data" : true
    } ],
    "recovery_conditions" : {
      "recovery_timeframe" : 2
    },
    "trigger_conditions" : [ {
      "aggregate_type" : "by",
      "aggregation_type" : "average",
      "aggregation_window" : "5m",
      "aom_monitor_level" : "",
      "cmdb" : {
        "app_id" : "",
        "node_ids" : [ ]
      },
      "expression" : "",
      "metric_labels" : [ ],
      "metric_name" : "aom_metrics_total",
      "metric_namespace" : "",
      "metric_query_mode" : "PROM",
      "metric_statistic_method" : "single",
      "metric_unit" : "",
      "mix_promql" : "",
      "operator" : ">",
      "promql" : "label_replace(avg_over_time(aom_metrics_total{instance=\"1117919565\"}[59999ms]),\"__name__\",\"aom_metrics_total\",\"\",\"\")",
      "query_match" : "",
      "query_param" : { },
      "thresholds" : {
        "Info" : "100"
      },
      "trigger_interval" : "15m",
      "trigger_times" : 4,
      "trigger_type" : "FIXED_RATE"
    } ]
  },
  "prom_instance_id" : "0"
}

Modify a metric alarm rule.

https://{Endpoint}/v4/{project_id}/alarm-rules?action_id=update-alarm-action

{
  "alarm_notifications" : {
    "bind_notification_rule_id" : "",
    "notification_enable" : false,
    "notification_type" : "alarm_policy",
    "notify_frequency" : -1,
    "notify_resolved" : true,
    "notify_triggered" : true,
    "route_group_enable" : true,
    "route_group_rule" : "aom_route_group_rule"
  },
  "alarm_rule_description" : "aom_alarm_rule",
  "alarm_rule_enable" : true,
  "alarm_rule_name" : "aom_alarm_rule",
  "alarm_rule_type" : "metric",
  "metric_alarm_spec" : {
    "alarm_rule_template_bind_enable" : false,
    "alarm_rule_template_id" : "",
    "alarm_tags" : [ {
      "auto_tags" : [ ],
      "custom_annotations" : [ "333=rrr" ],
      "custom_tags" : [ "333=rrr" ]
    } ],
    "monitor_objects" : [ ],
    "monitor_type" : "all_metric",
    "no_data_conditions" : [ {
      "no_data_alert_state" : "no_data",
      "no_data_timeframe" : 3,
      "notify_no_data" : true
    } ],
    "recovery_conditions" : {
      "recovery_timeframe" : 2
    },
    "trigger_conditions" : [ {
      "aggregate_type" : "by",
      "aggregation_type" : "average",
      "aggregation_window" : "5m",
      "aom_monitor_level" : "",
      "cmdb" : {
        "app_id" : "",
        "node_ids" : [ ]
      },
      "expression" : "",
      "metric_labels" : [ ],
      "metric_name" : "aom_metrics_total",
      "metric_namespace" : "",
      "metric_query_mode" : "PROM",
      "metric_statistic_method" : "single",
      "metric_unit" : "",
      "mix_promql" : "",
      "operator" : ">",
      "promql" : "label_replace(avg_over_time(aom_metrics_total{instance=\"1117919565\"}[59999ms]),\"__name__\",\"aom_metrics_total\",\"\",\"\")",
      "query_match" : "",
      "query_param" : { },
      "thresholds" : {
        "Info" : "100"
      },
      "trigger_interval" : "15m",
      "trigger_times" : 4,
      "trigger_type" : "FIXED_RATE"
    } ]
  },
  "prom_instance_id" : "0"
}

Add an event alarm rule.

https://{Endpoint}/v4/{project_id}/alarm-rules?action_id=add-alarm-action

{
  "alarm_notifications" : {
    "bind_notification_rule_id" : "aom_event_notification_rule",
    "notification_enable" : true,
    "notification_type" : "direct",
    "notify_frequency" : 0,
    "notify_resolved" : false,
    "notify_triggered" : false,
    "route_group_enable" : false,
    "route_group_rule" : ""
  },
  "alarm_rule_description" : "aom_alarm_event_rule",
  "alarm_rule_enable" : true,
  "alarm_rule_name" : "aom_event_alarm_rule",
  "alarm_rule_type" : "event",
  "event_alarm_spec" : {
    "alarm_source" : "systemEvent",
    "event_source" : "CCE",
    "monitor_objects" : [ {
      "event_name" : "ScaleUpTimedOut; VolumeResizeFailed",
      "event_type" : "event"
    } ],
    "trigger_conditions" : [ {
      "aggregation_window" : 300,
      "event_name" : "ScaleUpTimedOut",
      "frequency" : "-1",
      "operator" : ">",
      "thresholds" : {
        "Critical" : 1
      },
      "trigger_type" : "accumulative"
    }, {
      "event_name" : "VolumeResizeFailed",
      "thresholds" : {
        "Critical" : 1
      },
      "trigger_type" : "immediately"
    } ]
  }
}

Modify an event alarm rule.

https://{Endpoint}/v4/{project_id}/alarm-rules?action_id=update-alarm-action

{
  "alarm_notifications" : {
    "bind_notification_rule_id" : "aom_event_notification_rule",
    "notification_enable" : true,
    "notification_type" : "direct",
    "notify_frequency" : 0,
    "notify_resolved" : false,
    "notify_triggered" : false,
    "route_group_enable" : false,
    "route_group_rule" : ""
  },
  "alarm_rule_description" : "aom_alarm_event_rule",
  "alarm_rule_enable" : true,
  "alarm_rule_name" : "aom_event_alarm_rule",
  "alarm_rule_type" : "event",
  "event_alarm_spec" : {
    "alarm_source" : "systemEvent",
    "event_source" : "CCE",
    "monitor_objects" : [ {
      "event_name" : "ScaleUpTimedOut; VolumeResizeFailed",
      "event_type" : "event"
    } ],
    "trigger_conditions" : [ {
      "aggregation_window" : 300,
      "event_name" : "ScaleUpTimedOut",
      "frequency" : "-1",
      "operator" : ">",
      "thresholds" : {
        "Critical" : 1
      },
      "trigger_type" : "accumulative"
    }, {
      "event_name" : "VolumeResizeFailed",
      "thresholds" : {
        "Critical" : 2
      },
      "trigger_type" : "immediately"
    } ]
  }
}

Example Responses

Status code: 200

{
  "alarm_rules" : [ {
    "alarm_rule_name" : "aom_alarm_rule",
    "result" : "success"
  } ],
  "error_code" : "200",
  "error_message" : "success"
}

Status code: 400

{
  "error_code" : "AOM.02021006",
  "error_msg" : "This rule actionId is invalid",
  "error_type" : "PARAM_INVALID",
  "trace_id" : "58ef0f7c107a2b577f78b9cc7f48b46f"
}

Status code: 500

{
  "error_code" : "AOM.02021500",
  "error_msg" : "internal server error",
  "error_type" : "INTERNAL_SERVER_ERROR",
  "trace_id" : ""
}

Status Codes

Status Code	Description
200	OK: The request is successful.
400	Bad Request: Invalid request. The client should not repeat this request without modification.
500	Internal Server Error: The server is able to receive the request but unable to understand the request.

Error Codes

See Error Codes.

Parent topic: Alarm

Previous topic: Querying the Event Alarm Rule List

Next topic: Deleting Metric or Event Alarm Rules