CreateGroupMetricRules_时序指标报警规则_API参考

调用CreateGroupMetricRules接口批量创建应用分组报警规则。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	CreateGroupMetricRules	系统规定参数。取值：CreateGroupMetricRules。
GroupId	Long	是	123456	应用分组的ID。
GroupMetricRules.N.Category	String	是	ecs	产品名称或产品规格缩写。产品取值如下： ecs（包括阿里云和非阿里云主机） rds（云数据库RDS版） ads（分析型数据库） slb（负载均衡） vpc（弹性IP） apigateway（API网关） cdn cs（容器服务Swarm版） dcdn（全站加速） ddos eip（弹性公网IP） elasticsearch emr（E-MapReduce） ess（弹性伸缩） hbase iot_edge（IoT边缘计算） k8s_pod（k8s pod） kvstore_sharding（Redis集群版） kvstore_splitrw（Redis读写分离版） kvstore_standard（Redis标准版） memcache mns（消息服务） mongodb（MongoDB 副本实例） mongodb_cluster（MongoDB集群版本） mongodb_sharding（MongoDB分片集群） mq_topic（消息服务TOPIC） ocs（旧版云数据库Memcache） opensearch（开放搜索） oss（对象存储OSS） polardb petadata（HybridDB for MySQL） scdn（安全加速） sharebandwidthpackages（共享带宽包） sls（日志服务） vpn（VPN网关） N的取值范围为1~200。说明云监控接入的产品会不断增加，包括但不仅限于上述产品。
GroupMetricRules.N.MetricName	String	是	cpu_total	监控项名称。N的取值范围为1~200。说明详情请参见DescribeMetricMetaList或预设监控项参考。
GroupMetricRules.N.Namespace	String	是	acs_ecs_dashboard	产品的数据命名空间。N的取值范围为1~200。说明详情请参见DescribeMetricMetaList或预设监控项参考。
GroupMetricRules.N.RuleId	String	是	bfae2ca5b4e07d2c7278772eccda169808c7b****	报警规则ID。N的取值范围为1~200。说明由调用者统一生成以保证其唯一性。
GroupMetricRules.N.RuleName	String	是	报警规则1	报警规则名称。N的取值范围为1~200。
GroupMetricRules.N.Dimensions	String	否	[{"instanceId":"xxxxxx"}]	扩展资源维度。说明设置到组的报警规则会将组的实例资源全部关联到该报规则里。此参数设置除了实例外还可以设置更深一级的资源，例如想为应用分组下所有实例的根分区的磁盘使用率，此时可以设置为`[ {"dskName":"/"} ]`。 N的取值范围为1~200。
GroupMetricRules.N.EffectiveInterval	String	否	00:00-23:59	报警规则的生效时间范围。N的取值范围为1~200。
GroupMetricRules.N.EmailSubject	String	否	出现报警	报警邮件主题。N的取值范围为1~200。
GroupMetricRules.N.Escalations.Critical.ComparisonOperator	String	否	GreaterThanOrEqualToThreshold	Critical级别阈值比较符，您可以根据以下规则进行选择： `GreaterThanOrEqualToThreshold`：大于等于 `GreaterThanThreshold`：大于 `LessThanOrEqualToThreshold`：小于等于 `LessThanThreshold`：小于 `NotEqualToThreshold`：不等 `GreaterThanYesterday`：同比昨天时间上涨 `LessThanYesterday`：同比昨天时间下降 `GreaterThanLastWeek`：同比上周同一时间上涨 `LessThanLastWeek`：同比上周同一时间下降 `GreaterThanLastPeriod`：环比上周期上涨 `LessThanLastPeriod`：环比上周期下降 N的取值范围为1~200。
GroupMetricRules.N.Escalations.Critical.Statistics	String	否	Average	Critical级别报警统计方法。N的取值范围为1~200。说明关于级别统计方法的取值，请参见DescribeSystemEventMetaList。
GroupMetricRules.N.Escalations.Critical.Threshold	String	否	90	Critical级别报警阈值。N的取值范围为1~200。
GroupMetricRules.N.Escalations.Critical.Times	Integer	否	3	Critical级别报警重试次数。N的取值范围为1~200。
GroupMetricRules.N.Escalations.Info.ComparisonOperator	String	否	GreaterThanOrEqualToThreshold	Info级别阈值比较符，您可以根据以下规则进行选择： `GreaterThanOrEqualToThreshold`：大于等于 `GreaterThanThreshold`：大于 `LessThanOrEqualToThreshold`：小于等于 `LessThanThreshold`：小于 `NotEqualToThreshold`：不等 `GreaterThanYesterday`：同比昨天时间上涨 `LessThanYesterday`：同比昨天时间下降 `GreaterThanLastWeek`：同比上周同一时间上涨 `LessThanLastWeek`：同比上周同一时间下降 `GreaterThanLastPeriod`：环比上周期上涨 `LessThanLastPeriod`：环比上周期下降 N的取值范围为1~200。
GroupMetricRules.N.Escalations.Info.Statistics	String	否	Average	Info级别报警统计方法。N的取值范围为1~200。说明关于级别统计方法的取值，请参见DescribeSystemEventMetaList。
GroupMetricRules.N.Escalations.Info.Threshold	String	否	90	Info级别报警阈值。N的取值范围为1~200。
GroupMetricRules.N.Escalations.Info.Times	Integer	否	3	Info级别报警重试次数。N的取值范围为1~200。
GroupMetricRules.N.Escalations.Warn.ComparisonOperator	String	否	GreaterThanOrEqualToThreshold	Warn级别阈值比较符，您可以根据以下规则进行选择： `GreaterThanOrEqualToThreshold`：大于等于 `GreaterThanThreshold`：大于 `LessThanOrEqualToThreshold`：小于等于 `LessThanThreshold`：小于 `NotEqualToThreshold`：不等 `GreaterThanYesterday`：同比昨天时间上涨 `LessThanYesterday`：同比昨天时间下降 `GreaterThanLastWeek`：同比上周同一时间上涨 `LessThanLastWeek`：同比上周同一时间下降 `GreaterThanLastPeriod`：环比上周期上涨 `LessThanLastPeriod`：环比上周期下降 N的取值范围为1~200。
GroupMetricRules.N.Escalations.Warn.Statistics	String	否	Average	Warn级别报警统计方法。N的取值范围为1~200。说明关于级别统计方法的取值，请参见DescribeSystemEventMetaList。
GroupMetricRules.N.Escalations.Warn.Threshold	String	否	90	Warn级别报警阈值。N的取值范围为1~200。
GroupMetricRules.N.Escalations.Warn.Times	Integer	否	3	Warn级别报警重试次数。N的取值范围为1~200。
GroupMetricRules.N.Interval	String	否	60	报警规则的探测周期，即报警系统多长时间检查一次是否要触发报警规则。单位为秒，默认为监控项的最小频率。 N的取值范围为1~200。说明建议将报警的探测周期和上报数据周期保持一致，报警规则的探测周期小于上报周期会导致数据不足而不能触发报警。
GroupMetricRules.N.NoEffectiveInterval	String	否	00:00-05:30	报警规则非生效时间范围。N的取值范围为1~200。
GroupMetricRules.N.Period	String	否	60	监控数据的聚合周期，单位为秒，取值为60或60的整数倍。默认为300秒。说明设置成300秒即表示将原始上报的5分钟监控数据平均值（具体根据设置的`Statistics`）为1个点（假设原始上报监控数据为1分钟）作为是否报警的参考。 N的取值范围为1~200。
GroupMetricRules.N.SilenceTime	Integer	否	86400	一直处于报警状态的通知沉默周期，单位为秒，最短为3600秒（1小时），默认为86400秒（1天）。 N的取值范围为1~200。
GroupMetricRules.N.Webhook	String	否	http://www.aliyun.com	出现报警时候触发回调地址。N的取值范围为1~200。

报警的3种触发条件至少选择有一个，否则会创建不成功。

返回数据


名称	类型	示例值	描述
Code	Integer	200	状态码。说明状态码为200表示成功。
Message	String	success	错误信息。
RequestId	String	461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D	请求ID。
Resources	Array		创建影响的资源列表。
AlertResult			创建影响的资源列表。
Code	Integer	200	状态码。说明状态码为200表示成功。
Message	String	success	错误信息。
RuleId	String	a151cd6023eacee2f0978e03863cc1697c89508****	报警规则ID。
RuleName	String	报警规则1	报警规则名称。
Success	Boolean	true	请求是否成功。
Success	Boolean	true	请求是否成功。

示例

请求示例


http(s)://[Endpoint]/?Action=CreateGroupMetricRules
&GroupId=123456
&GroupMetricRules.1.Category=ecs
&GroupMetricRules.1.MetricName=cpu_total
&GroupMetricRules.1.namespace=acs_ecs_dashboard
&GroupMetricRules.1.RuleId=bfae2ca5b4e07d2c7278772eccda169808c7b****
&GroupMetricRules.1.RuleName=报警规则1
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>65D50468-ECEF-48F1-A6E1-D952E89D9436</RequestId>
<Success>true</Success>
<Code>200</Code>
<Resources>
    <AlertResult>
        <RuleId>a151cd6023eacee2f0978e03863cc1697c89508****</RuleId>
        <Success>true</Success>
        <RuleName>报警规则1</RuleName>
        <Code>200</Code>
    </AlertResult>
    <AlertResult>
        <Message>Metric not found.</Message>
        <RuleId>hyu91929****</RuleId>
        <Success>false</Success>
        <RuleName>报警规则2</RuleName>
        <Code>404</Code>
    </AlertResult>
</Resources>

JSON 格式

{
	"RequestId":"65D50468-ECEF-48F1-A6E1-D952E89D9436",
	"Success":"true",
	"Code":"200",
	"Resources":{
		"AlertResult":[
			{
				"RuleId":"a151cd6023eacee2f0978e03863cc1697c89508****",
				"RuleName":"报警规则1",
				"Success":"true",
				"Code":"200"
			},
			{
				"Message":"Metric not found.",
				"RuleId":"hyu91929****",
				"RuleName":"报警规则2",
				"Success":"false",
				"Code":"404"
			}
		]
	}
}

错误码

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