调用CreateMetricRuleTemplate接口创建报警模板-云监控-阿里云

调用CreateMetricRuleTemplate接口创建报警模板。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:CreateMetricRuleTemplate

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	报警模板名称。	Template1
Description	string	否	报警模板描述信息。	ECS_Template1
AlertTemplates	array<object>	否	报警模板列表。
	object	否	报警模板。
Escalations.Info.Threshold	string	否	普通级别报警阈值。 N 的取值范围：1~200。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	20
MetricName	string	是	监控项名称。 N 的取值范围：1~200。关于如何获取监控项，请参见 DescribeMetricMetaList 或云产品监控项。	cpu_total
Webhook	string	否	报警发生回调时的 URL 地址。 N 的取值范围：1~200。填写公网可访问的 URL 地址，云监控会将报警信息通过 POST 请求推送到该地址，目前仅支持 HTTP 协议。	http://ww.aliyun.com
Escalations.Warn.Threshold	string	否	警告级别报警阈值。 N 的取值范围：1~200。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	30
Namespace	string	是	云产品的数据命名空间。 N 的取值范围：1~200。关于如何获取云产品的数据命名空间，请参见 DescribeMetricMetaList 或云产品监控项。	acs_ecs_dashboard
Period	integer	否	监控数据的聚合周期。单位：秒。默认为监控项对应的最小周期，通常不需要指定。 N 的取值范围：1~200。	60
RuleName	string	是	报警规则名称。 N 的取值范围：1~200。	ECS_Rule1
Escalations.Critical.Times	integer	否	发送紧急报警通知需要监控指标达到报警阈值的次数。 N 的取值范围：1~200。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	3
Selector	string	否	Dimension 扩展字段的选项。 N 的取值范围：1~200。例如：报警模板被应用到了一个应用分组中，当该参数设置为`{"disk":"/"}`，监控项（MetricName）设置为`DiskUtilization`时，表示关联报警模板的应用分组中所有实例的磁盘根分区（`"/"`) 被关联到了对应报警规则中。说明关于扩展字段选项的取值，请参见 DescribeMetricRuleTemplateAttribute 。	{"disk":"/"}
Escalations.Info.Statistics	string	否	普通级别报警统计方法。 N 的取值范围：1~200。该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定，例如：Maximum、Minimum 和 Average。关于如何获取该参数的取值，请参见云产品监控项。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	Average
Escalations.Warn.Times	integer	否	发送警告报警通知需要监控指标达到报警阈值的次数。 N 的取值范围：1~200。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	1
Escalations.Info.ComparisonOperator	string	否	普通级别阈值比较符。取值： GreaterThanOrEqualToThreshold：大于等于。 GreaterThanThreshold：大于。 LessThanOrEqualToThreshold：小于等于。 LessThanThreshold：小于。 NotEqualToThreshold：不等于。 GreaterThanYesterday：同比昨天时间上涨。 LessThanYesterday：同比昨天时间下降。 GreaterThanLastWeek：同比上周同一时间上涨。 LessThanLastWeek：同比上周同一时间下降。 GreaterThanLastPeriod：环比上周期上涨。 LessThanLastPeriod：环比上周期下降。 N 的取值范围：1~200。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	GreaterThanOrEqualToThreshold
Category	string	是	云产品名称缩写。 N 的取值范围：1~200。关于如何获取云产品名称缩写，请参见 DescribeProjectMeta 接口的返回参数`Labels`中的`metricCategory`。	ecs
Escalations.Critical.Threshold	string	否	触发紧急级别报警通知的阈值。 N 的取值范围：1~200。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	30
Escalations.Critical.Statistics	string	否	紧急级别报警统计方法。 N 的取值范围：1~200。该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定，例如：Maximum、Minimum 和 Average。关于如何获取该参数的取值，请参见云产品监控项。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	Average
Escalations.Critical.ComparisonOperator	string	否	紧急级别阈值比较符。取值： GreaterThanOrEqualToThreshold：大于等于。 GreaterThanThreshold：大于。 LessThanOrEqualToThreshold：小于等于。 LessThanThreshold：小于。 NotEqualToThreshold：不等于。 GreaterThanYesterday：同比昨天时间上涨。 LessThanYesterday：同比昨天时间下降。 GreaterThanLastWeek：同比上周同一时间上涨。 LessThanLastWeek：同比上周同一时间下降。 GreaterThanLastPeriod：环比上周期上涨。 LessThanLastPeriod：环比上周期下降。 N 的取值范围：1~200。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	GreaterThanOrEqualToThreshold
Escalations.Warn.ComparisonOperator	string	否	警告级别阈值比较符。取值： GreaterThanOrEqualToThreshold：大于等于。 GreaterThanThreshold：大于。 LessThanOrEqualToThreshold：小于等于。 LessThanThreshold：小于。 NotEqualToThreshold：不等于。 GreaterThanYesterday：同比昨天时间上涨。 LessThanYesterday：同比昨天时间下降。 GreaterThanLastWeek：同比上周同一时间上涨。 LessThanLastWeek：同比上周同一时间下降。 GreaterThanLastPeriod：环比上周期上涨。 LessThanLastPeriod：环比上周期下降。 N 的取值范围：1~200。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	GreaterThanOrEqualToThreshold
Escalations.Info.Times	integer	否	发送普通报警通知需要监控指标达到报警阈值的次数。 N 的取值范围：1~200。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	1
Escalations.Warn.Statistics	string	否	警告级别报警统计方法。 N 的取值范围：1~200。该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定，例如：Maximum、Minimum 和 Average。关于如何获取该参数的取值，请参见云产品监控项。说明报警级别 Critical（严重）、Warn（警告）或 Info（信息）至少设置一个，且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。	Average

返回参数

名称	类型	描述	示例值
	object	返回数据。
Code	integer	状态码。说明 200 表示成功。	200
Message	string	错误信息。	The Request is not authorization.
RequestId	string	请求 ID。	9763ED1A-4D09-41BF-851E-310421750204
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
Id	integer	报警模板 ID。	12345

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "9763ED1A-4D09-41BF-851E-310421750204",
  "Success": true,
  "Id": 12345
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidQueryParameter	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
412	ResourcesOverLimit	Resources over limit.
500	InternalFailure	%s
402	LimitExceeded	The quota for this customer had been reached.
403	InvalidClientTokenId	not allow this operation.	没有权限
206	%s	%s
503	%s	%s
406	%s	%s
429	Throttli∂ngException	The request was denied due to request throttling.
409	%s	%s
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。