文档

PutGroupMetricRule - 创建或修改指定应用分组中的报警规则

更新时间:

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

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
GroupIdstring

应用分组 ID。

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

17285****
RuleIdstring

报警规则 ID。

  • 当您为该应用分组创建报警规则时,直接输入报警规则 ID。

  • 当您修改该应用分组中的指定报警规则时,需要获取报警规则 ID。关于如何获取报警规则 ID,请参见 DescribeMetricRuleList

123456
Categorystring

云产品名称缩写。

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

ECS
RuleNamestring

报警规则名称。

  • 当您为该应用分组创建报警规则时,直接输入报警规则名称。

  • 当您修改该应用分组中的指定报警规则时,需要获取报警规则名称。关于如何获取报警规则名称,请参见 DescribeMetricRuleList

Rule_01
Namespacestring

云产品的命名空间。

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

acs_ecs_dashboard
MetricNamestring

监控项名称。

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

cpu_total
Dimensionsstring

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

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

[{"instanceId":"i-m5e1qg6uo38rztr4****"}]
ExtraDimensionJsonstring

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

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

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

{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}
EffectiveIntervalstring

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

05:31-23:59
NoEffectiveIntervalstring

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

00:00-05:30
SilenceTimeinteger

通道沉默周期。

单位:秒。默认值:86400。

86400
Periodstring

监控数据的上报周期。

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

60
Intervalstring

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

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

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

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

https://www.aliyun.com
EmailSubjectstring

报警邮件主题。

ECS实例
ContactGroupsstring

报警联系组。

ECS_Group
Escalations.Critical.Statisticsstring

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

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

Average
Escalations.Critical.ComparisonOperatorstring

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

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

Critical 级别报警阈值。

90
Escalations.Critical.Timesinteger

Critical 级别报警重试次数。

3
Escalations.Warn.Statisticsstring

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

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

Average
Escalations.Warn.ComparisonOperatorstring

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

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

Warn 级别报警阈值。

90
Escalations.Warn.Timesinteger

Warn 级别报警重试次数。

3
Escalations.Info.Statisticsstring

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

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

Average
Escalations.Info.ComparisonOperatorstring

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

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

Info 级别报警阈值。

90
Escalations.Info.Timesinteger

Info 级别报警重试次数。

3
NoDataPolicystring

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

  • KEEP_LAST_STATE(默认值):不做任何处理。
  • INSUFFICIENT_DATA:报警内容为无数据。
  • OK:正常。
KEEP_LAST_STATE
Labelsobject []

报警规则标签。

报警通知中会包含标签。

Keystring

报警规则的标签键。

key1
Valuestring

报警规则的标签值。

value1
Optionsstring

高级设置。

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

{"NotSendOK":true}

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

返回参数

名称类型描述示例值
object

无。

Codestring

状态码。

说明 200 表示成功。
200
Messagestring

报错信息。

The Request is not authorization.
RequestIdstring

请求 ID。

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

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Resultobject

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

RuleIdstring

报警规则 ID。

123456

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
204%s%s

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

变更历史

变更时间变更内容概要操作
2023-12-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:204
    删除错误码:206
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:406
    删除错误码:499
    删除错误码:500
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:Options
2021-09-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:204
    删除错误码:206
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:406
    删除错误码:499
    删除错误码:500
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:Labels
  • 本页导读 (1)
文档反馈