Operation description
This topic provides an example to show how to create a threshold-triggered alert rule for the cpu_total
metric of an Elastic Compute Service (ECS) instance whose ID is i-uf6j91r34rnwawoo****
. The namespace of ECS is acs_ecs_dashboard
. The alert contact group of the alert rule is ECS_Group
. The name of the alert rule is test123
. The ID of the alert rule is a151cd6023eacee2f0978e03863cc1697c89508****
. The statistical method for Critical-level alerts is Average
. The comparison operator for Critical-level alerts is GreaterThanOrEqualToThreshold
. The threshold for Critical-level alerts is 90
. The consecutive number of times for which the metric value meets the trigger condition before a Critical-level alert is triggered is 3
.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RuleId | string | Yes | The ID of the alert rule. You can specify a new ID or the ID of an existing alert rule. For information about how to query the ID of an alert rule, see DescribeMetricRuleList . Note
If you specify a new ID, a threshold-triggered alert rule is created.
| a151cd6023eacee2f0978e03863cc1697c89508**** |
RuleName | string | Yes | The name of the alert rule. You can specify a new name or the name of an existing alert rule. For information about how to query the name of an alert rule, see DescribeMetricRuleList . Note
If you specify a new name, a threshold-triggered alert rule is created.
| test123 |
Namespace | string | Yes | The namespace of the cloud service. For information about how to query the namespace of a cloud service, see Appendix 1: Metrics. Note
If you create a Prometheus alert rule for Hybrid Cloud Monitoring, you must set this parameter to acs_prometheus .
| acs_ecs_dashboard |
MetricName | string | Yes | The name of the metric. For information about how to query the name of a metric, see Appendix 1: Metrics. Note
If you create a Prometheus alert rule for Hybrid Cloud Monitoring, you must set this parameter to the name of the namespace. For information about how to obtain the name of a namespace, see DescribeHybridMonitorNamespaceList .
| cpu_total |
Resources | string | Yes | The information about the resource. Examples: For information about the supported dimensions that are used to query resources, see Appendix 1: Metrics. | [{"instanceId":"i-uf6j91r34rnwawoo****"}] |
ContactGroups | string | Yes | The alert contact group. The alert notifications are sent to the contacts that belong to the alert contact group. Note
An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see PutContact and PutContactGroup .
| ECS_Group |
Webhook | string | No | The callback URL to which a POST request is sent when an alert is triggered based on the alert rule. | https://alert.aliyun.com.com:8080/callback |
EffectiveInterval | string | No | The time period during which the alert rule is effective. | 00:00-23:59 |
NoEffectiveInterval | string | No | The time period during which the alert rule is ineffective. | 00:00-06:00 |
SilenceTime | integer | No | The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400. Note
If an alert is not cleared within the mute period, a new alert notification is sent when the mute period ends.
| 86400 |
Period | string | No | The statistical period of the metric. Unit: seconds. The default value is the interval at which the monitoring data of the metric is collected. Note
For information about how to query the statistical period of a metric, see Appendix 1: Metrics.
| 60 |
Interval | string | No | The interval at which the alert is triggered. Unit: seconds. Note
For information about how to query the statistical period of a metric, see Appendix 1: Metrics.
| 60 |
EmailSubject | string | No | The subject of the alert notification email. | |
Escalations.Critical.Statistics | string | No | The statistical methods for Critical-level alerts. Valid values:
Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| Average |
Escalations.Critical.ComparisonOperator | string | No | The operator that is used to compare the metric value with the threshold. Valid values:
Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| GreaterThanOrEqualToThreshold |
Escalations.Critical.Threshold | string | No | The threshold for Critical-level alerts. Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| 90 |
Escalations.Critical.Times | integer | No | The consecutive number of times for which the metric value meets the trigger condition before a Critical-level alert is triggered. Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| 3 |
Escalations.Warn.Statistics | string | No | The statistical methods for Warn-level alerts. Valid values:
Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| Average |
Escalations.Warn.ComparisonOperator | string | No | The operator that is used to compare the metric value with the threshold. Valid values:
Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| GreaterThanOrEqualToThreshold |
Escalations.Warn.Threshold | string | No | The threshold for Warn-level alerts. Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| 90 |
Escalations.Warn.Times | integer | No | The consecutive number of times for which the metric value meets the trigger condition before a Warn-level alert is triggered. Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| 3 |
Escalations.Info.Statistics | string | No | The statistical methods for Info-level alerts. Valid values:
Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| Average |
Escalations.Info.ComparisonOperator | string | No | The operator that is used to compare the metric value with the threshold. Valid values:
Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| GreaterThanOrEqualToThreshold |
Escalations.Info.Threshold | string | No | The threshold for Info-level alerts. Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| 90 |
Escalations.Info.Times | integer | No | The consecutive number of times for which the metric value meets the trigger condition before an Info-level alert is triggered. Note
You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.
| 3 |
NoDataPolicy | string | No | The processing method of alerts when no monitoring data is found. Valid values:
| KEEP_LAST_STATE |
CompositeExpression | object | No | The trigger conditions for multiple metrics. Note
The trigger conditions for a single metric and multiple metrics are mutually exclusive. You cannot specify trigger conditions for a single metric and multiple metrics at the same time.
| |
ExpressionList | object [] | No | The trigger conditions that are created in standard mode. | |
MetricName | string | No | The metric that is used to monitor the cloud service. | cpu_total |
ComparisonOperator | string | No | The operator that is used to compare the metric value with the threshold. Valid values:
| GreaterThanOrEqualToThreshold |
Period | long | No | The aggregation period of the metric. Unit: seconds. | 60 |
Statistics | string | No | The statistical method of the metric. Valid values:
Note
$ is the prefix of the metric. For information about the Alibaba Cloud services that are supported by CloudMonitor, see Appendix 1: Metrics.
| $Maximum |
Threshold | string | No | The alert threshold. | 90 |
ExpressionListJoin | string | No | The relationship between the trigger conditions for multiple metrics. Valid values:
| || |
ExpressionRaw | string | No | The trigger conditions that are created by using expressions. You can use expressions to create trigger conditions in the following scenarios:
| $Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50) |
Level | string | No | The level of the alert. Valid values:
| Critical |
Times | integer | No | The number of consecutive triggers. If the number of times that the metric values meet the trigger conditions reaches the value of this parameter, CloudMonitor sends alert notifications. | 3 |
Labels | object [] | No | The tags. | |
Key | string | No | The key of the tag. | tagKey1 |
Value | string | No | The value of the tag. Note
You can use a template parameter to specify a tag value. CloudMonitor replaces the value of the template parameter with an actual tag value.
| ECS |
Prometheus | object | No | The Prometheus alert rule. Note
This parameter is required only when you create a Prometheus alert rule for Hybrid Cloud Monitoring.
| |
PromQL | string | No | The PromQL query statement. Note
The data obtained by using the PromQL query statement is the monitoring data. You must include the alert threshold in this statement.
| cpuUsage{instanceId="xxxx"}[1m]>90 |
Level | string | No | The level of the alert. Valid values:
| Critical |
Times | integer | No | The number of consecutive triggers. If the number of times that the metric values meet the trigger conditions reaches the value of this parameter, CloudMonitor sends alert notifications. | 3 |
Annotations | object [] | No | The annotations of the Prometheus alert rule. When a Prometheus alert is triggered, the system renders the annotated keys and values to help you understand the metrics and alert rule. Note
This parameter is equivalent to the annotations parameter of open source Prometheus.
| |
Key | string | No | The key of the annotation. | summary |
Value | string | No | The value of the annotation. | {{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} } |
For more information about common request parameters, see Common parameters.
Response parameters
Examples
Sample success responses
JSON
format
{
"Code": "200",
"Message": "The request processing has failed due to some unknown error.",
"RequestId": "65D50468-ECEF-48F1-A6E1-D952E89D9436",
"Success": true
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
204 | %s | %s |
429 | ResourceOverLimit | The resource has exceeded the limit. %s |
500 | InternalError | The request processing has failed due to some unknown error. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2022-12-26 | The Error code has changed | see changesets | ||||||||||||||||||||||
| ||||||||||||||||||||||||
2022-08-05 | The Error code has changed | see changesets | ||||||||||||||||||||||
|