Call CreateGroupMetricRules to create multiple alert rules for an application group - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Creates alert rules in batches for a specified application group by calling the CreateGroupMetricRules operation.

Operation description

This topic provides an example on how to create an alert rule for the monitoring metric cpu_total of Elastic Computing Service (ECS) in the application group 123456. The alert rule ID is 456789, the alert rule name is ECS_Rule1, the alert severity is Critical, the statistical method is Average, the comparison operator is GreaterThanOrEqualToThreshold, the threshold is 90, and the retry count is 3. The response shows that the alert rule ECS_Rule1 is created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:CreateGroupMetricRules

create

*GroupMetricRule

acs:cms::{#accountId}:group/{#groupId}

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	integer	Yes	The ID of the application group. For information about how to obtain the application group ID, see DescribeMonitorGroups.	3607****
GroupMetricRules	array<object>	No	The list of metric-based alert rules for the application group.
	array<object>	No	The metric-based alert rule for the application group.
Escalations.Info.Threshold	string	No	The threshold for Info-level alerts. Valid values of N: 1 to 200. Note Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	10
MetricName	string	Yes	The name of the metric. Valid values of N: 1 to 200. For information about how to obtain the metric name, see DescribeMetricMetaList or Cloud service monitoring.	cpu_total
Escalations.Warn.Threshold	string	No	The threshold for Warn-level alerts. Valid values of N: 1 to 200. Note Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	20
EffectiveInterval	string	No	The effective period of the alert rule. Valid values of N: 1 to 200.	05:31-23:59
NoEffectiveInterval	string	No	The time period during which the alert rule is ineffective. Valid values of N: 1 to 200.	00:00-05:30
RuleId	string	Yes	The ID of the alert rule. Valid values of N: 1 to 200.	456789
Escalations.Critical.Times	integer	No	The number of times that the monitoring metric must reach the alert threshold before a Critical-level alert notification is sent. Valid values of N: 1 to 200. Note Settings for at least one of the alert severity levels Critical, Warn (warning), or Info must be specified. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	3
Dimensions	string	No	The monitoring dimensions of the specified resource. The value is a collection of `key:value` pairs, such as `{"userId":"120886317861**"}` and `{"instanceId":"i-2ze2d6j5uhg20x47**"}`.	[{"instanceId":"i-m5e1qg6uo38rztr4****"}]
Escalations.Critical.Threshold	string	No	The threshold that triggers Critical-level alert notifications. Valid values of N: 1 to 200. Note Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	90
Escalations.Critical.Statistics	string	No	The statistical method for Critical-level alerts. Valid values of N: 1 to 200. The valid values of this parameter are determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the valid values, see Cloud service monitoring. Note Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	Average
Escalations.Warn.ComparisonOperator	string	No	The comparison operator for Warn-level alerts. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to the threshold. GreaterThanThreshold: greater than the threshold. LessThanOrEqualToThreshold: less than or equal to the threshold. LessThanThreshold: less than the threshold. NotEqualToThreshold: not equal to the threshold. GreaterThanYesterday: greater than the value at the same time yesterday. LessThanYesterday: less than the value at the same time yesterday. GreaterThanLastWeek: greater than the value at the same time last week. LessThanLastWeek: less than the value at the same time last week. GreaterThanLastPeriod: greater than the value in the last period. LessThanLastPeriod: less than the value in the last period. Valid values of N: 1 to 200. Note Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	GreaterThanOrEqualToThreshold
Escalations.Info.Times	integer	No	The number of times that the monitoring metric must reach the alert threshold before an Info-level alert notification is sent. Valid values of N: 1 to 200. Note Settings for at least one of the alert severity levels Critical, Warn (warning), or Info must be specified. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	1
SilenceTime	integer	No	The mute period of the alert notification. Valid values of N: 1 to 200. Unit: seconds. Default value: 86400. Minimum value: 3600.	86400
Webhook	string	No	The callback URL to which an alert notification is sent. Valid values of N: 1 to 200. Specify a publicly accessible URL. CloudMonitor sends a POST request to push alert information to this URL. Only the HTTP protocol is supported.	https://www.aliyun.com
Namespace	string	Yes	The namespace of the Alibaba Cloud service. Valid values of N: 1 to 200. For information about how to obtain the namespace of an Alibaba Cloud service, see DescribeMetricMetaList or Cloud service monitoring.	acs_ecs_dashboard
EmailSubject	string	No	The subject of the alert notification email. Valid values of N: 1 to 200.	ECS instance
Period	string	No	The reporting period of monitoring data. Valid values of N: 1 to 200. The value of `Period` must be 60 or a multiple of 60. Unit: seconds. Default value: 300.	60
RuleName	string	Yes	The name of the alert rule. Valid values of N: 1 to 200.	ECS_Rule1
Escalations.Info.Statistics	string	No	The statistical method for Info-level alerts. Valid values of N: 1 to 200. The valid values of this parameter are determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the valid values, see Cloud service monitoring. Note Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	Average
Escalations.Warn.Times	integer	No	The number of times that the monitoring metric must reach the alert threshold before a Warn-level alert notification is sent. Valid values of N: 1 to 200. Note Settings for at least one of the alert severity levels Critical, Warn (warning), or Info must be specified. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	3
Escalations.Info.ComparisonOperator	string	No	The comparison operator for Info-level alerts. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to the threshold. GreaterThanThreshold: greater than the threshold. LessThanOrEqualToThreshold: less than or equal to the threshold. LessThanThreshold: less than the threshold. NotEqualToThreshold: not equal to the threshold. GreaterThanYesterday: greater than the value at the same time yesterday. LessThanYesterday: less than the value at the same time yesterday. GreaterThanLastWeek: greater than the value at the same time last week. LessThanLastWeek: less than the value at the same time last week. GreaterThanLastPeriod: greater than the value in the last period. LessThanLastPeriod: less than the value in the last period. Valid values of N: 1 to 200. Note Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	GreaterThanOrEqualToThreshold
Interval	string	No	The detection period of the alert rule. Valid values of N: 1 to 200. Unit: seconds. The default value is the minimum reporting frequency of the metric. Note Keep the detection period of the alert rule consistent with the data reporting period. If the detection period is shorter than the data reporting period, alerts may not be triggered due to insufficient data.	60
Category	string	Yes	The abbreviation of the Alibaba Cloud service name. Valid values of N: 1 to 200. For information about how to obtain the abbreviation, see the `metricCategory` tag in the `Labels` response parameter of the DescribeProjectMeta operation.	ECS
Escalations.Critical.ComparisonOperator	string	No	The comparison operator for Critical-level alerts. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to the threshold. GreaterThanThreshold: greater than the threshold. LessThanOrEqualToThreshold: less than or equal to the threshold. LessThanThreshold: less than the threshold. NotEqualToThreshold: not equal to the threshold. GreaterThanYesterday: greater than the value at the same time yesterday. LessThanYesterday: less than the value at the same time yesterday. GreaterThanLastWeek: greater than the value at the same time last week. LessThanLastWeek: less than the value at the same time last week. GreaterThanLastPeriod: greater than the value in the last period. LessThanLastPeriod: less than the value in the last period. Valid values of N: 1 to 200. Note Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	GreaterThanOrEqualToThreshold
Escalations.Warn.Statistics	string	No	The statistical method for Warn-level alerts. Valid values of N: 1 to 200. The valid values of this parameter are determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the valid values, see Cloud service monitoring. Note Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.	Average
NoDataPolicy	string	No	The processing method when no monitoring data is found. Valid values: KEEP_LAST_STATE (default): No action is performed. INSUFFICIENT_DATA: An alert whose content is "Insufficient Data" is triggered. OK: The status is considered normal. Valid values of N: 1 to 200.	KEEP_LAST_STATE
ContactGroups	string	No	The alert contact group. Valid values of N: 1 to 200. For information about how to obtain the alert contact group, see DescribeContactGroupList.	ECS_Group
Labels	array<object>	No	The tag keys of the alert rule.
	object	No	The tag keys of the alert rule.
Key	string	No	The tag key of the alert rule. The tag is included in alert notifications. Valid values of N: 1 to 200.	key1
Value	string	No	The tag value of the alert rule. The tag is included in alert notifications. Valid values of N: 1 to 200.	value1
Options	string	No	The advanced settings. Format: {"key1":"value1","key2":"value2"}. For example, {"NotSendOK":true} specifies whether to send an alert recovery notification. The key is NotSendOK, and the value is true (do not send) or false (send, which is the default).	{ "NotSendOK": true }

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
Code	integer	The status code. Note A value of 200 indicates success.	200
Message	string	The error message.	The Request is not authorization.
RequestId	string	The request ID.	461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D
Success	boolean	Indicates whether the operation is successful. Valid values: true: The operation is successful. false: The operation failed.	true
Resources	object
AlertResult	array<object>	The list of alert rules.
	object
Code	integer	The status code of the newly created alert rule. Note A value of 200 indicates success.	200
Message	string	The error message of the newly created alert rule.	Metric not found.
Success	boolean	Indicates whether the alert rule was created. Valid values: true: Successful. false: Failed.	true
RuleName	string	The name of the newly created alert rule.	ECS_Rule1
RuleId	string	The ID of the newly created alert rule.	456789

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D",
  "Success": true,
  "Resources": {
    "AlertResult": [
      {
        "Code": 200,
        "Message": "Metric not found.",
        "Success": true,
        "RuleName": "ECS_Rule1",
        "RuleId": "456789"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	%s	%s
412	%s	%s
500	%s	%s
500	500	%s
403	%s	%s
404	%s	%s
409	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.