备案控制台
文档
产品文档
输入文档关键字查找
首页 云监控 开发参考 API参考 API目录 报警服务 阈值报警规则 PutResourceMetricRules - 为指定资源的指定监控项设置多条阈值报警规则

PutResourceMetricRules - 为指定资源的指定监控项设置多条阈值报警规则

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

调用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代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:PutResourceMetricRulesWrite
  • 全部资源
    *
    无
无

请求参数

名称类型必填描述示例值
Rulesobject []是

阈值报警规则列表。

N 的取值范围：1~500。

Escalations.Info.Thresholdstring否

Info 级别报警阈值。

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

监控项名称。

N 的取值范围：1~500。

关于如何查询监控项名称，请参见云产品监控项。

cpu_total
Escalations.Warn.Thresholdstring否

Warn 级别报警阈值。

N 的取值范围：1~500。

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

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

N 的取值范围：1~500。

00:00-23:59
NoEffectiveIntervalstring否

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

N 的取值范围：1~500。

00:00-06:00
RuleIdstring是

报警规则 ID。

N 的取值范围：1~500。

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

说明 输入新的报警规则 ID，表示创建一条阈值报警规则。
a151cd6023eacee2f0978e03863cc1697c89508****
Escalations.Critical.Timesinteger否

Critical 级别报警重试次数。

N 的取值范围：1~500。

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

Critical 级别报警阈值。

N 的取值范围：1~500。

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

Critical 级别报警统计方法。

N 的取值范围：1~500。

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

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

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

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

N 的取值范围：1~500。

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

Info 级别报警重试次数。

N 的取值范围：1~500。

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

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

N 的取值范围：1~500。

关于资源信息支持的维度 Dimensions，请参见云产品监控项。

[{"instanceId":"i-uf6j91r34rnwawoo****"}]
SilenceTimeinteger否

通道沉默周期。

单位：秒，默认值：86400。

N 的取值范围：1~500。

说明 通道沉默周期是指报警发生后未恢复正常，间隔多久重新发送一次报警通知。
86400
Webhookstring否

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

N 的取值范围：1~500。

https://alert.aliyun.com.com:8080/callback
ContactGroupsstring是

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

N 的取值范围：1~500。

说明 报警联系组是一组报警联系人，可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组，请参见 PutContact 和 PutContactGroup 。
ECS_Group
Namespacestring是

云产品的数据命名空间。

N 的取值范围：1~500。

关于如何查询云产品的数据命名空间，请参见云产品监控项。

acs_ecs_dashboard
EmailSubjectstring否

报警邮件主题。

N 的取值范围：1~500。

ECS实例报警
Periodstring否

监控项的统计周期。

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

N 的取值范围：1~500。

说明 关于如何查询监控项的统计周期，请参见云产品监控项。
60
RuleNamestring是

报警规则名称。

N 的取值范围：1~500。

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

说明 输入新的报警规则名称，表示创建一条阈值报警规则。
test123
Escalations.Info.Statisticsstring否

Info 级别报警统计方法。

N 的取值范围：1~500。

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

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

Warn 级别报警重试次数。

N 的取值范围：1~500。

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

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

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

N 的取值范围：1~500。

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

报警规则的触发周期。

单位：秒。

N 的取值范围：1~500。

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

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

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

N 的取值范围：1~500。

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

Warn 级别报警统计方法。

N 的取值范围：1~500。

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

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

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

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

N 的取值范围：1~500。

KEEP_LAST_STATE
Labelsobject []否

当监控项达到报警条件并进行报警时，标签同时写入监控项，在报警通知中进行展示。

Keystring否

标签键。

tagKey1
Valuestring否

标签值。

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

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

返回参数

名称类型描述示例值
object

无。

Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The request processing has failed due to some unknown error.
RequestIdstring

请求 ID。

15D1440E-BF24-5A41-93E4-36864635179E
Successboolean

操作是否成功。取值：

  • true：成功。

  • false：失败。

true
FailedListResultobject []

为资源设置报警规则的失败结果列表。

RuleIdstring

报警规则 ID。

a151cd6023eacee2f0978e03863cc1697c89508****
Resultobject

失败结果。

Codestring

状态码。

404
Messagestring

错误信息。

The request processing has failed due to some unknown error.
Successboolean

操作是否成功。取值：

  • true：成功。

  • false：失败。

false

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The request processing has failed due to some unknown error.",
  "RequestId": "15D1440E-BF24-5A41-93E4-36864635179E",
  "Success": true,
  "FailedListResult": {
    "Target": [
      {
        "RuleId": "a151cd6023eacee2f0978e03863cc1697c89508****",
        "Result": {
          "Code": "404",
          "Message": "The request processing has failed due to some unknown error.",
          "Success": false
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
204%s%s
500InternalErrorThe request processing has failed due to some unknown error.

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

变更历史

变更时间变更内容概要操作
2021-10-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：204
    删除错误码：206
    删除错误码：400
    删除错误码：403
    删除错误码：404
    删除错误码：406
    删除错误码：422
    删除错误码：499
    删除错误码：500
    删除错误码：503
文档推荐
  • 本页导读 （1）
文档反馈