Creates an alert rule for a metric for a resource.

This topic provides an example to show how to create a threshold-triggered alert rule for the cpu_total metric for an Elastic Compute Service (ECS) instance whose ID is i-uf6j91r34rnwawoo**** instance. The namespace of ECS is acs_ecs_dashboard. The response shows that the alert contact group of the alert rule is ECS_Group, the name of the alert rule is test123, and 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 alert condition before a Critical-level alert is triggered is 3.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes PutResourceMetricRule

The operation that you want to perform. Set the value to PutResourceMetricRule.

ContactGroups String Yes ECS_Group

The alert contact group. The alert notifications of the application group 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 more information about how to create alert contacts and alert contact groups, see PutContact and PutContactGroup.
MetricName String Yes cpu_total

The name of the metric. For more information about how to query metric names, see Appendix 1: Metrics.

Namespace String Yes acs_ecs_dashboard

The namespace of the cloud service. For more information about how to query the namespaces of cloud services, see Appendix 1: Metrics.

Resources String Yes [{"instanceId":"i-uf6j91r34rnwawoo****"}]

The information about the resource. Example: [{"instanceId":"i-uf6j91r34rnwawoo****"}] or [{"userId":"100931896542****"}].

For more information about the supported dimensions used to query resources, see Appendix 1: Metrics.

RuleId String Yes a151cd6023eacee2f0978e03863cc1697c89508****

The ID of the alert rule.

You can set a new alert rule ID or specify the ID of an existing alert rule. For more information about how to query alert rule IDs, see DescribeMetricRuleList.

Note If you set a new alert rule ID, you create a threshold-triggered alert rule.
RuleName String Yes test123

The name of the alert rule.

You can set a new alert rule name or specify the name of an existing alert rule. For more information about how to query alert rule names, see DescribeMetricRuleList.

Note If you set a new alert rule name, you create a threshold-triggered alert rule.
Webhook String No https://alert.aliyun.com.com:8080/callback

The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.

EffectiveInterval String No 00:00-23:59

The time period during which the alert rule is effective.

NoEffectiveInterval String No 00:00-06:00

The time period during which the alert rule is ineffective.

SilenceTime Integer No 86400

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.
Interval String No 60

The interval at which the alert is triggered. Unit: seconds.

Note For more information about how to query the statistical periods of metrics, see Appendix 1: Metrics.
EmailSubject String No Alert for an ECS instance

The subject of the alert notification email.

Period String No 60

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 more information about how to query the statistical periods of metrics, see Appendix 1: Metrics.
Escalations.Critical.Statistics String No Average

The statistical methods for Critical-level alerts. Valid values:

  • Maximum: the maximum value
  • Minimum: the minimum value
  • Average: the average value
  • Availability: the availability rate
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.
Escalations.Critical.ComparisonOperator String No GreaterThanOrEqualToThreshold

The comparison operator that is used to compare the metric value with the threshold. 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 metric value at the same time yesterday
  • LessThanYesterday: less than the metric value at the same time yesterday
  • GreaterThanLastWeek: greater than the metric value at the same time last week
  • LessThanLastWeek: less than the metric value at the same time last week
  • GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle
  • LessThanLastPeriod: less than the metric value in the last monitoring cycle
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.
Escalations.Critical.Threshold String No 90

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.
Escalations.Critical.Times Integer No 3

The consecutive number of times for which the metric value meets the alert 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.
Escalations.Warn.Statistics String No Average

The statistical methods for Warn-level alerts. Valid values:

  • Maximum: the maximum value
  • Minimum: the minimum value
  • Average: the average value
  • Availability: the availability rate
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.
Escalations.Warn.ComparisonOperator String No GreaterThanOrEqualToThreshold

The comparison operator that is used to compare the metric value with the threshold. 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 metric value at the same time yesterday
  • LessThanYesterday: less than the metric value at the same time yesterday
  • GreaterThanLastWeek: greater than the metric value at the same time last week
  • LessThanLastWeek: less than the metric value at the same time last week
  • GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle
  • LessThanLastPeriod: less than the metric value in the last monitoring cycle
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.
Escalations.Warn.Threshold String No 90

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.
Escalations.Warn.Times Integer No 3

The consecutive number of times for which the metric value meets the alert 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.
Escalations.Info.Statistics String No Average

The statistical methods for Info-level alerts. Valid values:

  • Maximum: the maximum value
  • Minimum: the minimum value
  • Average: the average value
  • Availability: the availability rate
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.
Escalations.Info.ComparisonOperator String No GreaterThanOrEqualToThreshold

The comparison operator that is used to compare the metric value with the threshold. 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 metric value at the same time yesterday
  • LessThanYesterday: less than the metric value at the same time yesterday
  • GreaterThanLastWeek: greater than the metric value at the same time last week
  • LessThanLastWeek: less than the metric value at the same time last week
  • GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle
  • LessThanLastPeriod: less than the metric value in the last monitoring cycle
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.
Escalations.Info.Threshold String No 90

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.
Escalations.Info.Times Integer No 3

The consecutive number of times for which the metric value meets the alert 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.
NoDataPolicy String No KEEP_LAST_STATE

The processing method of alerts when no monitoring data is found. Valid values:

  • KEEP_LAST_STATE (default value): No operation is performed.
  • INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.
  • OK: The alert rule has no active alerts.
Labels.N.Key String No tagKey1

The key of the tag that is bound to the resource.

Labels.N.Value String No ECS

The value of the tag that is bound to the resource.

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

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code.

Note The status code 200 indicates that the call is successful.
Message String The request processing has failed due to some unknown error.

The error message.

RequestId String 65D50468-ECEF-48F1-A6E1-D952E89D9436

The ID of the request.

Success Boolean true

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.

Examples

Sample requests

http(s)://[Endpoint]/?Action=PutResourceMetricRule
&ContactGroups=ECS_Group
&MetricName=cpu_total
&Namespace=acs_ecs_dashboard
&Resources=[{"instanceId":"i-uf6j91r34rnwawoo****"}]
&RuleId=a151cd6023eacee2f0978e03863cc1697c89508****
&RuleName=test123
&Escalations.Critical.Statistics=Average
&Escalations.Critical.ComparisonOperator=GreaterThanOrEqualToThreshold
&Escalations.Critical.Threshold=90
&Escalations.Critical.Times=3
&<Common request parameters>

Sample success responses

XML format

<PutResourceMetricRuleResponse>
	  <Code>200</Code>
	  <Message></Message>
	  <RequestId>65D50468-ECEF-48F1-A6E1-D952E89D9436</RequestId>
	  <Success>true</Success>
</PutResourceMetricRuleResponse>

JSON format

{
   "Code":"200",
   "Message":"",
   "RequestId":"65D50468-ECEF-48F1-A6E1-D952E89D9436",
   "Success":true   
}

Error codes

For a list of error codes, visit the API Error Center.