调用PutGroupMetricRule接口创建或修改组报警规则。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String PutGroupMetricRule

系统规定参数。取值:PutGroupMetricRule。

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。

说明 云监控接入的产品会不断增加,包括但不仅限于上述产品。
GroupId String 123456

应用分组ID。

MetricName String cpu_total

监控项名称。

说明 详情请参见DescribeMetricMetaList预设监控项参考
Namespace String acs_ecs_dashboard

产品的数据命名空间。

说明 详情请参见DescribeMetricMetaList预设监控项参考
RuleId String bfae2ca5b4e07d2c7278772eccda169808c7b****

报警规则ID。

Dimensions String [{"instanceId":"xxxxxx"}]

维度map,用于查询指定资源的监控数据。

格式为key-value键值对形式的集合,常用的key-value集合为instanceId:XXXXXX

keyvalue的长度为1~64个字节,超过64个字节时截取前64字节。keyvalue的取值可包含字母、数字、点号(.)、短横线(-)、下划线(_)、正斜线(/)和反斜线(\)。

说明 Dimensions传入时需要使用JSON字符串表示该map对象,必须按顺序传入。
EffectiveInterval String 00:00-23:59

报警规则的生效时间范围。

EmailSubject String 出现报警

报警邮件主题。

Escalations.Critical.ComparisonOperator String GreaterThanOrEqualToThreshold

Critical级别阈值比较符。您可以根据以下规则进行选择:

  • GreaterThanOrEqualToThreshold:大于等于
  • GreaterThanThreshold:大于
  • LessThanOrEqualToThreshold:小于等于
  • LessThanThreshold:小于
  • NotEqualToThreshold:不等
  • GreaterThanYesterday:同比昨天时间上涨
  • LessThanYesterday:同比昨天时间下降
  • GreaterThanLastWeek:同比上周同一时间上涨
  • LessThanLastWeek:同比上周同一时间下降
  • GreaterThanLastPeriod:环比上周期上涨
  • LessThanLastPeriod:环比上周期下降
Escalations.Critical.Statistics String Average

Critical级别报警统计方法。

说明 详情请参见DescribeMetricMetaList
Escalations.Critical.Threshold String 90

Critical级别报警阈值。

Escalations.Critical.Times Integer 3

Critical级别报警重试次数。

Escalations.Info.ComparisonOperator String GreaterThanOrEqualToThreshold

Info级别阈值比较符。您可以根据以下规则进行选择:

  • GreaterThanOrEqualToThreshold:大于等于
  • GreaterThanThreshold:大于
  • LessThanOrEqualToThreshold:小于等于
  • LessThanThreshold:小于
  • NotEqualToThreshold:不等
  • GreaterThanYesterday:同比昨天时间上涨
  • LessThanYesterday:同比昨天时间下降
  • GreaterThanLastWeek:同比上周同一时间上涨
  • LessThanLastWeek:同比上周同一时间下降
  • GreaterThanLastPeriod:环比上周期上涨
  • LessThanLastPeriod:环比上周期下降
Escalations.Info.Statistics String Average

Info级别报警统计方法。

说明 详情请参见DescribeMetricMetaList
Escalations.Info.Threshold String 90

Info级别报警阈值。

Escalations.Info.Times Integer 3

Info级别报警重试次数。

Escalations.Warn.ComparisonOperator String GreaterThanOrEqualToThreshold

Warn级别阈值比较符。您可以根据以下规则进行选择:

  • GreaterThanOrEqualToThreshold:大于等于
  • GreaterThanThreshold:大于
  • LessThanOrEqualToThreshold:小于等于
  • LessThanThreshold:小于
  • NotEqualToThreshold:不等
  • GreaterThanYesterday:同比昨天时间上涨
  • LessThanYesterday:同比昨天时间下降
  • GreaterThanLastWeek:同比上周同一时间上涨
  • LessThanLastWeek:同比上周同一时间下降
  • GreaterThanLastPeriod:环比上周期上涨
  • LessThanLastPeriod:环比上周期下降
Escalations.Warn.Statistics String Average

Warn级别报警统计方法。

说明 详情请参见DescribeMetricMetaList
Escalations.Warn.Threshold String 90

Warn级别报警阈值。

Escalations.Warn.Times Integer 3

Warn级别报警重试次数。

Interval String 60

报警规则的探测周期,即报警系统多长时间检查一次是否要触发报警规则。单位为秒,默认为监控项的最小频率。

说明 建议将报警的探测周期和上报数据周期保持一致,报警规则的探测周期小于上报周期会导致数据不足而不能触发报警。
NoEffectiveInterval String 00:00-05:30

报警规则非生效时间范围。

Period String 60

监控数据的聚合周期,单位为秒,取值为60或60的整数倍。默认为300秒。

RuleName String 报警规则1

报警规则名称。

SilenceTime Integer 86400

通道沉默周期,单位为秒,默认为86400秒(1天)。

Webhook String http://www.aliyun.com

报警发生时回调指定的URL地址。

返回数据

名称 类型 示例值 描述
RequestId String 461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D

请求ID。

Success Boolean true

请求是否成功。

Code String 200

状态码。

说明 状态码为200表示成功。
Message String success

错误信息。

示例

请求示例


http(s)://[Endpoint]/?Action=PutGroupMetricRule
&Category=ecs
&GroupId=123456
&MetricName=cpu_total
&Namespace=acs_ecs_dashboard
&RuleId=bfae2ca5b4e07d2c7278772eccda169808c7b****
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>26C766DE-E759-4B38-8B23-28589C491CEF</RequestId>
<Code>200</Code>
<Success>true</Success>

JSON 格式

{
	"RequestId":"26C766DE-E759-4B38-8B23-28589C491CEF",
	"Success":true,
	"Code":200
}

错误码

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