调用PutGroupMetricRule接口创建或修改指定应用分组中的报警规则。

本文将提供一个示例,为应用分组17285****中的云服务器ECS的监控项cpu_total创建一条报警规则,其中报警规则的ID为123456,报警规则名称为Rule_test,报警级别为Critical,报警统计方法为Average,报警阈值比较符为GreaterThanOrEqualToThreshold,报警阈值为90,报警重试次数为3。返回结果显示,创建报警规则成功,报警规则ID为123456

调试

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

请求参数

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

要执行的操作,取值:PutGroupMetricRule

GroupId String 17285****

应用分组ID。

关于如何获取应用分组ID,请参见DescribeMonitorGroups

RuleId String 123456

报警规则ID。

  • 当您为该应用分组创建报警规则时,直接输入报警规则ID。
  • 当您修改该应用分组中的指定报警规则时,需要获取报警规则ID。关于如何获取报警规则ID,请参见DescribeMetricRuleList
Category String ECS

云产品名称。取值:

  • PolarDB:云数据库PolarDB。
  • NewBGPDDoS:新BGP高防IP。
  • IoTDevice:物联网平台。
  • DRDS:云原生分布式数据库PolarDB-X。
  • VS:视频监控。
  • AMQP:消息队列AMQP。
  • ADS:分析型数据库。
  • APIGateway:API网关。
  • InternetSharedBandwidth:共享带宽。
  • CDN:内容分发网络。
  • CEN:云企业网。
  • DCDN:全站加速。
  • DDoS:DDoS高防IP。
  • ECS:云服务器ECS。
  • DirectMail:邮件推送。
  • Elasticsearch:阿里云Elasticsearch。
  • EMR:E-MapReduce。
  • ESS:弹性伸缩。
  • FunctionCompute:函数计算。
  • RealtimeCompute:流计算。
  • GlobalAcceleration:全球加速。
  • Hbase:云数据库Hbase。
  • TSDB:时序数据库。
  • IPv6trans:IPv6转换服务。
  • Kafka:消息队列Kafka。
  • Kubernetes:容器服务Kubernetes版。
  • KVstore:云数据库Redis版。
  • MNS:消息服务MNS。
  • MongoDB:云数据库MongoDB版。
  • MQ:消息队列MQ。
  • NAT:NAT网关。
  • OpenAd:营销引擎。
  • OpenSearch:开放搜索。
  • OSS:对象存储OSS。
  • PCDN:安全加速。
  • petadata:HybridDB for MySQL。
  • RDS:云数据库RDS版。
  • SCDN:安全加速。
  • SLB:负载均衡。
  • SLS:日志服务。
  • VideoLive:视频直播。
  • VOD:视频点播。
  • EIP:弹性公网IP。
  • VPN:VPN网关。
  • AIRec:智能推荐。
  • GPDB:分析型数据库PostgreSQL版。
  • DBS:数据库备份DBS。
  • SAG:智能接入网关。
  • Memcache:云数据库Memcache版。
  • IOT_EDGE:IoT-边缘计算。
  • OCS:云数据库Memcache(旧版)。
  • VPC:高速通道。
  • EHPC:弹性高性能计算E-HPC。
  • MPS:媒体处理。
  • ENS:边缘节点服务ENS。
  • MaxCompute_Prepay:MaxCompute。
  • IoT_Kubernetes:边缘应用托管。
  • CMS:云监控。
  • batchcomputenew:批量计算。
  • HBaseUE:HBase增强版。
  • UIS:极致互联网服务。
  • nls:智能语音交互。
  • ots:表格存储。
  • NAS:文件存储NAS。
  • ECI:弹性容器实例ECI。
  • OpenAPI:阿里云OpenAPI。
  • pvtzpost:云解析PrivateZone。
  • blinkonk8s:实时计算云原生。
  • FunctionFlow:函数工作流。
  • SMC:服务器迁移中心。
  • ddosbgp:DDoS原生防护。
  • baas:区块链服务。
  • privatelink:私网连接。
  • cds:云数据库Cassandra版。
  • DDH:专有宿主机。
  • RocketMQ:消息队列RocketMQ。
  • ECC:高速上云服务。
  • hbaseserverless:HBase Serverless版。
  • mns_tmp:消息服务。
  • hdr:混合云容灾。
  • hbr:混合云备份服务。
  • ADB:分析型数据库MySQL版3.0。
  • tag:标签。
  • GDB:图数据库。
  • WAF:Web应用防火墙。
  • hcs_sgw:云存储网关。
  • ipv6gateway:IPv6网关。
  • RDS_SAR:云数据库专属主机组。
  • learn:机器学习。
  • ROS:资源编排。
  • OOS:运维编排。
  • bds:HBase数据同步服务。
  • cfw:云防火墙。
  • ddosDip:DDoS高防(国际)。
  • datahub:数据总线。
  • hologres:交互式分析。
  • ExpressConnect:高速通道的专线连接。
  • dbfs:数据库文件系统。
  • clickhouse:云数据库Clickhouse。
  • k8s:容器服务Kubernetes版。
  • DTS:数据传输。
  • AnycastEIP:Anycast弹性公网IP。
  • Lindorm:云原生多模数据库Lindorm。
  • config:配置审计。
  • spark:Databricks数据洞察。
  • serverless:Serverless应用引擎。
  • alb:应用型负载均衡。
  • oceanbase:OceanBase分布式数据库。
  • KMS:密钥管理服务。
  • lvwang:内容安全。
  • LinkVisual:视频边缘智能服务。
  • tair:云数据库Redis企业版。
  • dlf:数据湖构建。
  • networkmonitor:站点监控。
  • pnc:物理网络变更。
  • AIS:阿里云基础设施。
  • cloudgame:云游戏平台。
  • RTC:音视频通信RTC。
  • cloudbox:云盒。
  • actiontrail:操作审计。
  • cc:云连接器。
  • disk:块存储。
  • easygene:基因分析平台。
  • cloudphone:弹性云手机。
  • BMS:裸机管理服务。
  • swas:轻量应用服务器。
  • AvailabilityMonitoring:云监控下的可用性监控。
RuleName String Rule_01

报警规则名称。

  • 当您为该应用分组创建报警规则时,直接输入报警规则名称。
  • 当您修改该应用分组中的指定报警规则时,需要获取报警规则名称。关于如何获取报警规则名称,请参见DescribeMetricRuleList
Namespace String acs_ecs_dashboard

云产品的命名空间。

关于如何获取云产品的命名空间,请参见DescribeMetricMetaList云产品监控项

MetricName String cpu_total

监控项名称。

关于如何获取监控项名称,请参见DescribeMetricMetaList云产品监控项

Dimensions String [{"instanceId":"i-m5e1qg6uo38rztr4****"}]

应用分组中报警规则的第一级维度。

格式:key-value键值对形式的集合,例如:userId:120886317861****instanceId:i-m5e1qg6uo38rztr4****

ExtraDimensionJson String {"/dev/xvda":"d-m5e6yphgzn3aprwu****"}

应用分组中报警规则的第二级或第三级维度。

格式:key-value键值对形式的集合,例如:port:80/dev/xvda:d-m5e6yphgzn3aprwu****

当报警规则的第一级维度为instanceId:i-m5e1qg6uo38rztr4****时,其第二级维度为该实例中的云盘/dev/xvda:d-m5e6yphgzn3aprwu****

EffectiveInterval String 05:31-23:59

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

NoEffectiveInterval String 00:00-05:30

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

SilenceTime Integer 86400

通道沉默周期。

单位:秒。默认值:86400。

Period String 60

监控数据的上报周期。

Period的取值为60或60的整数倍。单位:秒。默认值:300。

Interval String 60

报警规则的探测周期。单位:秒。

说明 建议报警规则的探测周期和数据上报周期保持一致。如果报警规则的探测周期小于数据上报周期,会因为数据不足而不能触发报警。
Webhook String https://www.aliyun.com

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

填写公网可访问的URL地址,云监控会将报警信息通过POST请求推送到该地址,目前仅支持HTTP协议。

EmailSubject String ECS实例

报警邮件主题。

ContactGroups String ECS_Group

报警联系组。

Escalations.Critical.Statistics String Average

Critical级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。取值:

  • Average:平均值。
  • Minimum:最小值。
  • Maximum:最大值。
Escalations.Critical.ComparisonOperator String GreaterThanOrEqualToThreshold

Critical级别阈值比较符。取值:

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

Critical级别报警阈值。

Escalations.Critical.Times Integer 3

Critical级别报警重试次数。

Escalations.Warn.Statistics String Average

Warn级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。取值:

  • Average:平均值。
  • Minimum:最小值。
  • Maximum:最大值。
Escalations.Warn.ComparisonOperator String GreaterThanOrEqualToThreshold

Warn级别阈值比较符。取值:

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

Warn级别报警阈值。

Escalations.Warn.Times Integer 3

Warn级别报警重试次数。

Escalations.Info.Statistics String Average

Info级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。取值:

  • Average:平均值。
  • Minimum:最小值。
  • Maximum:最大值。
Escalations.Info.ComparisonOperator String GreaterThanOrEqualToThreshold

Info级别阈值比较符。取值:

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

Info级别报警阈值。

Escalations.Info.Times Integer 3

Info级别报警重试次数。

NoDataPolicy String KEEP_LAST_STATE

无监控数据时报警的处理方式。取值:

  • KEEP_LAST_STATE(默认值):不做任何处理。
  • INSUFFICIENT_DATA:报警内容为无数据。
  • OK:正常。
Labels.N.Key String key1

报警规则的标签键。

Labels.N.Value String value1

报警规则的标签值。

关于公共请求参数的详情,请参见公共参数

返回数据

名称 类型 示例值 描述
Code String 200

状态码。

说明 200表示成功。
Message String The Request is not authorization.

报错信息。

RequestId String 461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D

请求ID。

Success Boolean true

操作是否成功。取值:

  • true:成功。
  • false:失败。
Result Object

创建或修改报警规则的结果。

RuleId String 123456

报警规则ID。

示例

请求示例

http(s)://[Endpoint]/?Action=PutGroupMetricRule
&Category=ECS
&GroupId=17285****
&MetricName=cpu_total
&Namespace=acs_ecs_dashboard
&RuleId=123456
&RuleName=`Rule_test
&Escalations.Critical.Statistics=Average
&Escalations.Critical.ComparisonOperator=GreaterThanOrEqualToThreshold
&Escalations.Critical.Threshold=90
&Escalations.Critical.Times=3
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<PutGroupMetricRuleResponse>
	<Message></Message>
	<RequestId>461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D</RequestId>
	<Code>200</Code>
	<Success>true</Success>
	<Result>
		<RuleId>123456</RuleId>
	</Result>
</PutGroupMetricRuleResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "",
  "RequestId" : "461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D",
  "Code" : 200,
  "Success" : true,
  "Result" : {
    "RuleId" : "123456"
  }
}

错误码

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