调用PutResourceMetricRules接口为指定资源的指定监控项设置多条阈值报警规则。

本文将提供一个示例，为云服务器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 是 PutResourceMetricRules

要执行的操作，取值：PutResourceMetricRules。
Rules.N.Escalations.Info.Threshold String 否 90

Info级别报警阈值。

说明 报警级别Critical（严重）、Warn（警告）或Info（信息）至少设置一个，且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Rules.N.MetricName String 否 cpu_total

监控项名称。

N的取值范围：1~500。

关于如何查询监控项名称，请参见云产品监控项。
Rules.N.Escalations.Warn.Threshold String 否 90

Warn级别报警阈值。

N的取值范围：1~500。

说明 报警级别Critical（严重）、Warn（警告）或Info（信息）至少设置一个，且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Rules.N.EffectiveInterval String 否 00:00-23:59

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

N的取值范围：1~500。
Rules.N.NoEffectiveInterval String 否 00:00-06:00

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

N的取值范围：1~500。
Rules.N.RuleId String 是 a151cd6023eacee2f0978e03863cc1697c89508****

报警规则ID。

N的取值范围：1~500。

您可以输入新的报警规则ID，也可以使用云监控已存在的报警规则ID。关于如何查询报警规则ID，请参见DescribeMetricRuleList。

说明 输入新的报警规则ID，表示创建一条阈值报警规则。
Rules.N.Escalations.Critical.Times Integer 否 3

Critical级别报警重试次数。

N的取值范围：1~500。

说明 报警级别Critical（严重）、Warn（警告）或Info（信息）至少设置一个，且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Rules.N.Escalations.Critical.Threshold String 否 90

Critical级别报警阈值。

N的取值范围：1~500。

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

Critical级别报警统计方法。

N的取值范围：1~500。

该参数的取值由指定云产品的MetricName对应的Statistics列决定，例如：Maximum、Minimum和Average。关于如何获取该参数的取值，请参见云产品监控项。

说明 报警级别Critical（严重）、Warn（警告）或Info（信息）至少设置一个，且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Rules.N.Escalations.Warn.ComparisonOperator String 否 GreaterThanOrEqualToThreshold

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

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

N的取值范围：1~500。

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

Info级别报警重试次数。

N的取值范围：1~500。

说明 报警级别Critical（严重）、Warn（警告）或Info（信息）至少设置一个，且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Rules.N.Resources String 是 [{"instanceId":"i-uf6j91r34rnwawoo****"}]

资源信息，例如：[{"instanceId":"i-uf6j91r34rnwawoo****"}]、[{"userId":"100931896542****"}]。

N的取值范围：1~500。

关于资源信息支持的维度Dimensions，请参见云产品监控项。
Rules.N.SilenceTime Integer 否 86400

通道沉默周期。

单位：秒，默认值：86400。

N的取值范围：1~500。

说明 通道沉默周期是指报警发生后未恢复正常，间隔多久重新发送一次报警通知。
Rules.N.Webhook String 否 https://alert.aliyun.com.com:8080/callback

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

N的取值范围：1~500。
Rules.N.ContactGroups String 是 ECS_Group

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

N的取值范围：1~500。

说明 报警联系组是一组报警联系人，可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组，请参见PutContact和PutContactGroup。
Rules.N.Namespace String 是 acs_ecs_dashboard

云产品的数据命名空间。

N的取值范围：1~500。

关于如何查询云产品的数据命名空间，请参见云产品监控项。
Rules.N.EmailSubject String 否 ECS实例报警

报警邮件主题。

N的取值范围：1~500。
Rules.N.Period String 否 60

监控项的统计周期。

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

N的取值范围：1~500。

说明 关于如何查询监控项的统计周期，请参见云产品监控项。
Rules.N.RuleName String 是 test123

报警规则名称。

N的取值范围：1~500。

您可以输入新的报警规则名称，也可以使用云监控已存在的报警规则名称。关于如何查询报警规则名称，请参见DescribeMetricRuleList。

说明 输入新的报警规则名称，表示创建一条阈值报警规则。
Rules.N.Escalations.Info.Statistics String 否 Average

Info级别报警统计方法。

N的取值范围：1~500。

该参数的取值由指定云产品的MetricName对应的Statistics列决定，例如：Maximum、Minimum和Average。关于如何获取该参数的取值，请参见云产品监控项。

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

Warn级别报警重试次数。

N的取值范围：1~500。

说明 报警级别Critical（严重）、Warn（警告）或Info（信息）至少设置一个，且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Rules.N.Escalations.Info.ComparisonOperator String 否 GreaterThanOrEqualToThreshold

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

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

N的取值范围：1~500。

说明 报警级别Critical（严重）、Warn（警告）或Info（信息）至少设置一个，且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Rules.N.Interval String 否 60

报警规则的触发周期。

单位：秒。

N的取值范围：1~500。

说明 关于如何查询监控项的统计周期，请参见云产品监控项。
Rules.N.Escalations.Critical.ComparisonOperator String 否 GreaterThanOrEqualToThreshold

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

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

N的取值范围：1~500。

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

Warn级别报警统计方法。

N的取值范围：1~500。

该参数的取值由指定云产品的MetricName对应的Statistics列决定，例如：Maximum、Minimum和Average。关于如何获取该参数的取值，请参见云产品监控项。

说明 报警级别Critical（严重）、Warn（警告）或Info（信息）至少设置一个，且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。
Rules.N.NoDataPolicy String 否 KEEP_LAST_STATE

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

  • KEEP_LAST_STATE（默认值）：不做任何处理。
  • INSUFFICIENT_DATA：报警内容为无数据。
  • OK：正常。

N的取值范围：1~500。
Rules.N.Labels.N.Key String 否 tagKey1

标签键。
Rules.N.Labels.N.Value String 否 ECS

标签值。

说明 标签值支持模板参数，将模板参数替换为实际标签值。

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

返回数据

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

状态码。

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

错误信息。
RequestId String 15D1440E-BF24-5A41-93E4-36864635179E

请求ID。
Success Boolean true

操作是否成功。取值：

  • true：成功。
  • false：失败。
FailedListResult Array of Target

为资源设置报警规则的失败结果列表。
Target
RuleId String a151cd6023eacee2f0978e03863cc1697c89508****

报警规则ID。
Result Object

失败结果。
Code String 404

状态码。
Message String The request processing has failed due to some unknown error.

错误信息。
Success Boolean false

操作是否成功。取值：

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

示例

请求示例

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

正常返回示例

XML格式

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

<PutResourceMetricRulesResponse>
	<Message></Message>
	<RequestId>15D1440E-BF24-5A41-93E4-36864635179E</RequestId>
	<FailedListResult></FailedListResult>
	<Code>200</Code>
	<Success>true</Success>
</PutResourceMetricRulesResponse>

JSON格式

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

{
  "Message" : "",
  "RequestId" : "15D1440E-BF24-5A41-93E4-36864635179E",
  "FailedListResult" : {
    "Target" : [ ]
  },
  "Code" : "200",
  "Success" : true
}

错误码

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