AI 助理
备案控制台
文档
输入文档关键字查找
首页 云监控 开发参考 API参考 API目录 报警服务 阈值报警规则 CreateGroupMetricRules - 批量为指定应用分组创建报警规则

CreateGroupMetricRules - 批量为指定应用分组创建报警规则

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

调用CreateGroupMetricRules接口批量为指定应用分组创建报警规则。

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
GroupIdlong是

应用分组 ID。

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

3607****
GroupMetricRulesarray<object>否

应用分组的监控项规则列表。

object否

应用分组的监控项规则。

Escalations.Info.Thresholdstring否

普通级别报警阈值。

N 的取值范围：1~200。

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

监控项名称。

N 的取值范围：1~200。

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

cpu_total
Escalations.Warn.Thresholdstring否

警告级别报警阈值。

N 的取值范围：1~200。

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

报警规则的生效时间范围。N 的取值范围：1~200。

05:31-23:59
NoEffectiveIntervalstring否

报警规则的失效时间范围。N 的取值范围：1~200。

00:00-05:30
RuleIdstring是

报警规则 ID。

N 的取值范围：1~200。

456789
Escalations.Critical.Timesinteger否

发送紧急报警通知需要监控指标达到报警阈值的次数。

N 的取值范围：1~200。

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

指定资源的监控维度。

格式：key:value键值对形式的集合，例如：{"userId":"120886317861****"}和{"instanceId":"i-2ze2d6j5uhg20x47****"}。

[{"instanceId":"i-m5e1qg6uo38rztr4****"}]
Escalations.Critical.Thresholdstring否

触发紧急级别报警通知的阈值。

N 的取值范围：1~200。

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

紧急级别报警统计方法。

N 的取值范围：1~200。

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

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

警告级别阈值比较符。取值：

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

N 的取值范围：1~200。

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

发送普通报警通知需要监控指标达到报警阈值的次数。

N 的取值范围：1~200。

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

报警通知的沉默周期。N 的取值范围：1~200。

单位：秒。默认值：86400。最小值：3600。

86400
Webhookstring否

报警发生回调时的 URL 地址。N 的取值范围：1~200。

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

https://www.aliyun.com
Namespacestring是

云产品的数据命名空间。

N 的取值范围：1~200。

关于如何获取云产品的数据命名空间，请参见 DescribeMetricMetaList 或云产品监控项。

acs_ecs_dashboard
EmailSubjectstring否

报警邮件主题。

N 的取值范围：1~200。

ECS实例
Periodstring否

监控数据的上报周期。

N 的取值范围：1~200。

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

60
RuleNamestring是

报警规则名称。

N 的取值范围：1~200。

ECS_Rule1
Escalations.Info.Statisticsstring否

普通级别报警统计方法。

N 的取值范围：1~200。

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

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

发送警告报警通知需要监控指标达到报警阈值的次数。

N 的取值范围：1~200。

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

普通级别阈值比较符。取值：

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

N 的取值范围：1~200。

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

报警规则的探测周期。

N 的取值范围：1~200。

单位：秒。秒默认为监控项的最小频率。

说明 建议报警规则的探测周期和数据上报周期保持一致。如果报警规则的探测周期小于数据上报周期，会因为数据不足而不能触发报警。
60
Categorystring是

云产品名称缩写。

N 的取值范围：1~200。

关于如何获取云产品名称缩写，请参见 DescribeProjectMeta 接口的返回参数Labels中的metricCategory。

ECS
Escalations.Critical.ComparisonOperatorstring否

紧急级别阈值比较符。取值：

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

N 的取值范围：1~200。

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

警告级别报警统计方法。

N 的取值范围：1~200。

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

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

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

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

N 的取值范围：1~200。

KEEP_LAST_STATE
ContactGroupsstring否

报警联系人组。

N 的取值范围：1~200。

关于如何获取报警联系人组，请参见 DescribeContactGroupList 。

ECS_Group
Labelsarray<object>否

报警规则的标签键。

object否

报警规则的标签键。

Keystring否

报警规则的标签键。报警通知中会包含标签。

N 的取值范围：1~200。

key1
Valuestring否

报警规则的标签值。报警通知中会包含标签。

N 的取值范围：1~200。

value1
Optionsstring否

高级设置。

格式：{"key1":"value1","key2":"value2"}，例如：{"NotSendOK":true}，表示是否发送报警恢复通知，key 为 NotSendOK，value 为 true（不发送）或 false（默认发送）。

{ "NotSendOK": true }

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

返回参数

名称类型描述示例值
object
Codeinteger

状态码。

说明 200 表示成功。
200
Messagestring

报错信息。

The Request is not authorization.
RequestIdstring

请求 ID。

461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D
Successboolean

操作是否成功。取值：

  • true：成功。

  • false：失败。

true
Resourcesarray<object>

报警规则列表。

object
Codeinteger

新创建报警规则的状态码。

说明 200 表示成功。
200
Messagestring

新创建报警规则的错误信息。

Metric not found.
Successboolean

新创建报警规则是否成功。取值：

  • true：成功。

  • false：失败。

true
RuleNamestring

新创建报警规则的名称。

ECS_Rule1
RuleIdstring

新创建报警规则的 ID。

456789

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D",
  "Success": true,
  "Resources": {
    "AlertResult": [
      {
        "Code": 200,
        "Message": "Metric not found.",
        "Success": true,
        "RuleName": "ECS_Rule1",
        "RuleId": "456789"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400%s%s
500500%s

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

变更历史

变更时间变更内容概要操作
2023-12-13OpenAPI 错误码发生变更查看变更详情
2021-10-28OpenAPI 错误码发生变更查看变更详情
2021-10-28OpenAPI 错误码发生变更查看变更详情
上一篇：DescribeMetricRuleList - 查询报警规则列表中的所有规则下一篇：CreateMetricRuleResources - 创建一个报警规则关联的资源
文档推荐