Creates an alert template.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateMetricRuleTemplate | The operation that you want to perform. Set the value to CreateMetricRuleTemplate. |
Name | String | Yes | Template1 | The name of the alert template. |
Description | String | No | ECS_Template1 | The description of the alert template. |
AlertTemplates.N.Escalations.Info.Threshold | String | No | 20 | The threshold for Info-level alerts. |
AlertTemplates.N.MetricName | String | Yes | cpu_total | The name of the metric. Valid values of N: 1 to 200.
Note For more information, see
DescribeMetricMetaList or
Appendix 1: Metrics.
|
AlertTemplates.N.Webhook | String | No | http://ww.aliyun.com | The callback URL to which a POST request is sent when an alert is triggered based on the alert rule. |
AlertTemplates.N.Escalations.Warn.Threshold | String | No | 30 | The threshold for Warn-level alerts. |
AlertTemplates.N.Namespace | String | Yes | acs_ecs_dashboard | The namespace of the cloud service. Valid values of N: 1 to 200.
Note For more information, see
DescribeMetricMetaList or
Appendix 1: Metrics.
|
AlertTemplates.N.Period | Integer | No | 60 | The aggregation period of monitoring data. Unit: seconds. The default value is the minimum aggregation period. Generally, you do not need to specify the minimum aggregation period. Valid values of N: 1 to 200. |
AlertTemplates.N.RuleName | String | Yes | My CPU monitoring | The name of the alert rule. Valid values of N: 1 to 200. |
AlertTemplates.N.Escalations.Critical.Times | Integer | No | 2 | The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered. |
AlertTemplates.N.Selector | String | No | {"disk":"/"} | The extended field selectors. Valid values of N: 1 to 200. |
AlertTemplates.N.Escalations.Info.Statistics | String | No | Average | The statistical method for Info-level alerts. |
AlertTemplates.N.Escalations.Warn.Times | Integer | No | 1 | The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered. |
AlertTemplates.N.Escalations.Info.ComparisonOperator | String | No | GreaterThanOrEqualToThreshold | The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values of N: 1 to 200. 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.
|
AlertTemplates.N.Category | String | Yes | ecs | The abbreviation of the Alibaba Cloud service name. To obtain the abbreviation of an Alibaba Cloud service name, call the DescribeProjectMeta operation. The |
AlertTemplates.N.Escalations.Critical.Threshold | String | No | 30 | The threshold for Critical-level alerts. |
AlertTemplates.N.Escalations.Critical.Statistics | String | No | Average | The statistical method for Critical-level alerts. |
AlertTemplates.N.Escalations.Critical.ComparisonOperator | String | No | GreaterThanOrEqualToThreshold | The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values of N: 1 to 200. Valid values:
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.
|
AlertTemplates.N.Escalations.Warn.ComparisonOperator | String | No | GreaterThanOrEqualToThreshold | The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values of N: 1 to 200. 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.
|
AlertTemplates.N.Escalations.Info.Times | Integer | No | 1 | The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered. |
AlertTemplates.N.Escalations.Warn.Statistics | String | No | Average | The statistical method for Warn-level alerts. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | Integer | 200 | The HTTP status code.
Note The status code 200 indicates that the call was successful.
|
Message | String | The Request is not authorization. | The error message. |
RequestId | String | 9763ED1A-4D09-41BF-851E-310421750204 | The ID of the request. |
Success | Boolean | true | Indicates whether the call was successful. Valid values:
|
Id | Long | 12345 | The ID of the alert template. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=CreateMetricRuleTemplate
&Name=Template1
&AlertTemplates.1.MetricName=cpu_total
&AlertTemplates.1.RuleName=My CPU monitoring
&AlertTemplates.1.Category=ecs
&AlertTemplates.1.1amespace=acs_ecs_dashboard
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateMetricRuleTemplateResponse>
<RequestId>9763ED1A-4D09-41BF-851E-310421750204</RequestId>
<Id>12345</Id>
<Success>true</Success>
<Code>200</Code>
</CreateMetricRuleTemplateResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "9763ED1A-4D09-41BF-851E-310421750204",
"Id" : 12345,
"Success" : true,
"Code" : 200
}
Error codes
For a list of error codes, see Service error codes.