调用PutResourceMetricRule接口为单个资源的监控项设置阈值报警规则。

本文将提供一个示例,为云服务器ECS acs_ecs_dashboard的实例i-uf6j91r34rnwawoo****中的监控项cpu_total设置阈值报警规则。该报警规则的报警联系组为ECS_Group、报警规则名称为test123、报警规则ID为a151cd6023eacee2f0978e03863cc1697c89508****、Critical级别的统计方法为Average、Critical级别的比较符为GreaterThanOrEqualToThreshold、Critical级别的阈值为90和Critical级别的报警重试次数为3

调试

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

请求参数

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

要执行的操作,取值:PutResourceMetricRule。

ContactGroups String ECS_Group

报警联系组。报警通知会发送给该报警联系组中的报警联系人。

说明 报警联系组是一组报警联系人,可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组,请参见 PutContactPutContactGroup
MetricName String cpu_total

监控项名称。关于如何查询监控项名称,请参见云服务监控项

Namespace String acs_ecs_dashboard

云服务的数据命名空间。关于如何查询云服务的数据命名空间,请参见云服务监控项

Resources String [{"instanceId":"i-uf6j91r34rnwawoo****"}]

资源信息,例如:[{"instanceId":"i-uf6j91r34rnwawoo****"}][{"userId":"100931896542****"}]

关于资源信息支持的维度Dimensions,请参见云服务监控项

RuleId String a151cd6023eacee2f0978e03863cc1697c89508****

报警规则ID。关于如何查询报警规则ID,请参见DescribeMetricRuleList

RuleName String test123

报警规则名称。关于如何查询报警规则名称,请参见DescribeMetricRuleList

Webhook String https://alert.aliyun.com.com:8080/callback

报警发生回调时指定的URL地址,向URL发送POST请求。

EffectiveInterval String 00:00-23:59

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

NoEffectiveInterval String 00:00-06:00

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

SilenceTime Integer 86400

通道沉默周期。单位:秒,默认值:86400。

说明 通道沉默周期是指报警发生后未恢复正常,间隔多久重新发送一次报警通知。
Interval String 60

报警规则的触发周期。单位:秒。

说明 关于如何查询监控项的统计周期,请参见 云服务监控项
EmailSubject String ECS实例报警

报警邮件主题。

Period String 60

监控项的统计周期。单位:秒。默认为监控项的原始上报周期。

说明 关于如何查询监控项的统计周期,请参见 云服务监控项
Escalations.Critical.Statistics String Average

Critical级别报警统计方法。取值:

  • Maximum:最大值。
  • Minimum:最小值。
  • Average:平均值。
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Escalations.Critical.ComparisonOperator String GreaterThanOrEqualToThreshold

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

  • GreaterThanOrEqualToThreshold:大于等于。
  • GreaterThanThreshold:大于。
  • LessThanOrEqualToThreshold:小于等于。
  • LessThanThreshold:小于。
  • NotEqualToThreshold:不等。
  • GreaterThanYesterday:同比昨天时间上涨。
  • LessThanYesterday:同比昨天时间下降。
  • GreaterThanLastWeek:同比上周同一时间上涨。
  • LessThanLastWeek:同比上周同一时间下降。
  • GreaterThanLastPeriod:环比上周期上涨。
  • LessThanLastPeriod:环比上周期下降。
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Escalations.Critical.Threshold String 90

Critical级别报警阈值。

说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Escalations.Critical.Times Integer 3

Critical级别报警重试次数。

说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Escalations.Warn.Statistics String Average

Warn级别报警统计方法。取值:

  • Maximum:最大值。
  • Minimum:最小值。
  • Average:平均值。
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Escalations.Warn.ComparisonOperator String GreaterThanOrEqualToThreshold

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

  • GreaterThanOrEqualToThreshold:大于等于。
  • GreaterThanThreshold:大于。
  • LessThanOrEqualToThreshold:小于等于。
  • LessThanThreshold:小于。
  • NotEqualToThreshold:不等。
  • GreaterThanYesterday:同比昨天时间上涨。
  • LessThanYesterday:同比昨天时间下降。
  • GreaterThanLastWeek:同比上周同一时间上涨。
  • LessThanLastWeek:同比上周同一时间下降。
  • GreaterThanLastPeriod:环比上周期上涨。
  • LessThanLastPeriod:环比上周期下降。
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Escalations.Warn.Threshold String 90

Warn级别报警阈值。

说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Escalations.Warn.Times Integer 3

Warn级别报警重试次数。

说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Escalations.Info.Statistics String Average

Info级别报警统计方法。取值:

  • Maximum:最大值。
  • Minimum:最小值。
  • Average:平均值。
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Escalations.Info.ComparisonOperator String GreaterThanOrEqualToThreshold

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

  • GreaterThanOrEqualToThreshold:大于等于。
  • GreaterThanThreshold:大于。
  • LessThanOrEqualToThreshold:小于等于。
  • LessThanThreshold:小于。
  • NotEqualToThreshold:不等。
  • GreaterThanYesterday:同比昨天时间上涨。
  • LessThanYesterday:同比昨天时间下降。
  • GreaterThanLastWeek:同比上周同一时间上涨。
  • LessThanLastWeek:同比上周同一时间下降。
  • GreaterThanLastPeriod:环比上周期上涨。
  • LessThanLastPeriod:环比上周期下降。
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Escalations.Info.Threshold String 90

Info级别报警阈值。

说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Escalations.Info.Times Integer 3

Info级别报警重试次数。

说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。

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

返回数据

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

状态码。

说明 200表示成功。
Message String The request processing has failed due to some unknown error.

错误信息。

RequestId String 65D50468-ECEF-48F1-A6E1-D952E89D9436

请求ID。

Success Boolean true

操作是否成功。取值:

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

示例

请求示例

http(s)://[Endpoint]/?Action=PutResourceMetricRule
&ContactGroups=ECS_Group
&MetricName=cpu_total
&Namespace=acs_ecs_dashboard
&Resources=[{"instanceId":"i-uf6j91r34rnwawoo****"}]
&RuleId=a151cd6023eacee2f0978e03863cc1697c89508****
&RuleName=test123
&Escalations.Critical.Statistics=Average
&Escalations.Critical.ComparisonOperator=GreaterThanOrEqualToThreshold
&Escalations.Critical.Threshold=90
&Escalations.Critical.Times=3
&<公共请求参数>

正常返回示例

XML格式

<PutResourceMetricRuleResponse>
	  <Code>200</Code>
	  <Message></Message>
	  <RequestId>65D50468-ECEF-48F1-A6E1-D952E89D9436</RequestId>
	  <Success>true</Success>
</PutResourceMetricRuleResponse>

JSON格式

{
   "Code":"200",
   "Message":"",
   "RequestId":"65D50468-ECEF-48F1-A6E1-D952E89D9436",
   "Success":true   
}

错误码

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