ModifyMetricRuleTemplate - CloudMonitor - Alibaba Cloud Documentation Center

Modifies an alert template.

Operation Description

This topic provides an example on how to modify an alert template whose version is 1 and ID is 123456. The alert level is changed to Critical. The statistical method is changed to Average. The alert threshold comparator is changed to GreaterThanOrEqualToThreshold. The alert threshold is changed to 90. The number of alert retries is changed to 3. The response shows that the alert template is modified.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	long	Yes	The ID of the alert template. For information about how to obtain the ID of an alert template, see DescribeMetricRuleTemplateList.	123456
Name	string	No	The name of the alert template. For information about how to obtain the name of an alert template, see DescribeMetricRuleTemplateList.	test123
Description	string	No	The description of the alert template.	ECS_template1
RestVersion	long	Yes	The version of the alert template. The version changes with the number of times that the alert template is modified. For information about how to obtain the version of an alert template, see DescribeMetricRuleTemplateList.	0
AlertTemplates	object []	No	The details of the alert template.
Escalations.Info.Threshold	string	No	The threshold for Info-level alerts. Valid values of N: 1 to 200. 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.	20
MetricName	string	No	The metric name. Valid values of N: 1 to 200. For information about how to obtain metrics, see DescribeMetricMetaList or Appendix 1: Metrics.	cpu_total
Webhook	string	No	The callback URL. Valid values of N: 1 to 200. The callback URL must be accessible over the Internet. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.	https://apiwebhook.hipac.cn/api/v1/alarm/aly/eregfeeferrtbnmkdszp
Escalations.Warn.Threshold	string	No	The threshold for Warn-level alerts. Valid values of N: 1 to 200. 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.	30
Namespace	string	No	The namespace of the cloud service. Valid values of N: 1 to 200. For information about how to obtain the namespace of a cloud service, see DescribeMetricMetaList or Appendix 1: Metrics.	acs_ecs_dashboard
Period	integer	No	The statistical period of the monitoring data. Valid values of N: 1 to 200. Note If the value is set to 300 seconds, the monitoring data is collected every 300 seconds. If the monitoring data is reported every 1 minute, the alert system calculates the average, maximum, and minimum values of the monitoring data of 5 minutes and checks whether the aggregated values exceed the threshold. To prevent unexpected alerts, we recommend that you set this parameter together with other parameters.	60
RuleName	string	No	The name of the alert rule. Valid values of N: 1 to 200.	rule1
Escalations.Critical.Times	integer	No	The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered. Valid values of N: 1 to 200. 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.	2
Selector	string	No	The dimension of the alert. It is an extended field. Valid values of N: 1 to 200. For example, an alert template is applied to an application group, this parameter is set to `{"disk":"/"}`, and the MetricName parameter is set to `DiskUtilization`. In this case, the generated alert rule is applied to the root disk partition (`"/"`) of all instances in the application group to which the alert template is applied. Note For more information about the values of extended fields, see DescribeMetricRuleTemplateAttribute.	{"disk":"/"}
Escalations.Info.Statistics	string	No	The statistical method for Info-level alerts. Valid values of N: 1 to 200. The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see Appendix 1: Metrics. 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.Times	integer	No	The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered. Valid values of N: 1 to 200. 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.	1
Escalations.Info.ComparisonOperator	string	No	The operator that is used to compare the metric value with the threshold 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 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 Valid values of N: 1 to 200. 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
Category	string	No	The abbreviation of the cloud service name. Valid values of N: 1 to 200. For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the DescribeProjectMeta operation.	ecs
Escalations.Critical.Threshold	string	No	The threshold for Critical-level alerts. Valid values of N: 1 to 200. 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.	30
Escalations.Critical.Statistics	string	No	The statistical method for Critical-level alerts. Valid values of N: 1 to 200. The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see Appendix 1: Metrics. 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 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 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 Valid values of N: 1 to 200. 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.ComparisonOperator	string	No	The operator that is used to compare the metric value with the threshold 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 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 Valid values of N: 1 to 200. 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.Times	integer	No	The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered. Valid values of N: 1 to 200. 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.	1
Escalations.Warn.Statistics	string	No	The statistical method for Warn-level alerts. Valid values of N: 1 to 200. The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see Appendix 1: Metrics. 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

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

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The HTTP status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The error message.	The Request is not authorization.
RequestId	string	The request ID.	9E07117F-F6AE-4F1C-81E8-36FBB4892235
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "9E07117F-F6AE-4F1C-81E8-36FBB4892235",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
206	%s	%s
400	InvalidQueryParameter	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
402	LimitExceeded	The quota for this customer had been reached.
403	InvalidClientTokenId	The X.509 certificate or cms access key ID provided does not exist in our records.
429	Throttli∂ngException	The request was denied due to request throttling.
500	InternalFailure	%s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history