Operation description
Before you call this operation, call the PutCustomMetric operation to report custom monitoring data. For more information, see PutCustomMetric .
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
GroupId | string | No | The ID of the application group to which the custom monitoring data belongs. Note
The value 0 indicates that the reported custom monitoring data does not belong to an application group.
| 7378**** |
RuleId | string | Yes | The ID of the alert rule. Note
You can specify an existing ID to modify the corresponding alert rule or specify a new ID to create an alert rule.
| MyRuleId1 |
RuleName | string | No | The name of the alert rule. | CpuUsage |
MetricName | string | Yes | The name of the metric. Note
For more information about how to obtain the metric name, see DescribeCustomMetricList .
| cpu_total |
Resources | string | Yes | The custom monitoring data to which the alert rule applies. The value includes the application group ID to which the custom monitoring data belongs and the dimension to which the metric belongs. | [{"groupId":7378****,"dimension":"instanceId=i-hp3543t5e4sudb3s****"}] |
ContactGroups | string | Yes | The alert group that receives alert notifications. Separate multiple alert groups with commas (,). | 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://www.aliyun.com |
EffectiveInterval | string | No | The time period during which the alert rule is effective. Valid values: 00:00 to 23:59. | 00:00-23:59 |
SilenceTime | integer | No | The mute period during which notifications are not repeatedly sent for an alert. Unit: seconds. Default value: 86400. The default value indicates one day. Note
Only one alert notification is sent during each mute period even if the metric value consecutively exceeds the alert threshold several times.
| 86400 |
Period | string | No | The cycle that is used to aggregate custom monitoring data. Unit: seconds. Set the value to an integral multiple of 60. The original reporting cycle of custom monitoring data is used by default. | 300 |
EmailSubject | string | No | The subject of the alert notification email. | |
Threshold | string | Yes | The threshold of the metric value. | 90 |
Level | string | Yes | The level of the alert. Valid values:
| CRITICAL |
EvaluationCount | integer | Yes | The consecutive number of times for which the metric value is measured before an alert is triggered. | 3 |
Statistics | string | Yes | The method that is used to calculate the metric values that trigger alerts. | Average |
ComparisonOperator | string | Yes | The comparison operator before the threshold. Valid values:
| >= |
Response parameters
Examples
Sample success responses
JSON
format
{
"Code": "200",
"Message": "ComparisonOperator is mandatory for this action.",
"RequestId": "65D50468-ECEF-48F1-A6E1-D952E89D9432",
"Success": true
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
403 | %s | %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 |
---|