AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页 云监控 云监控1.0 开发参考 API参考 API目录 报警服务 报警模板 ModifyMetricRuleTemplate - 修改报警模板

ModifyMetricRuleTemplate - 修改报警模板

更新时间：
复制为 MD 格式
产品详情
我的收藏

调用ModifyMetricRuleTemplate接口修改报警模板。

接口说明

本文将提供一个示例，修改版本1的报警模板123456，将报警级别修改为Critical，报警统计方法修改为Average，报警阈值比较符修改为GreaterThanOrEqualToThreshold，报警阈值修改为90，报警重试次数修改为3。返回结果显示，修改报警模板成功。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:ModifyMetricRuleTemplate

update

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
TemplateId

integer

是

报警模板 ID。

关于如何获取报警模板 ID，请参见 DescribeMetricRuleTemplateList 。

123456
Name

string

否

报警模板名称。

关于如何获取报警模板名称，请参见 DescribeMetricRuleTemplateList 。

Template_123
Description

string

否

报警模板描述。

ECS_template1
RestVersion

integer

是

报警模板的版本。该参数随报警模板的修改次数自动更新。

关于如何获取报警模板的版本，请参见 DescribeMetricRuleTemplateList 。

1
AlertTemplates

array<object>

否

报警模板列表。

object

否

报警模板列表。

Escalations.Info.Threshold

string

否

普通级别报警阈值。

N 的取值范围：1~200。

说明

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

20
MetricName

string

否

监控项名称。

N 的取值范围：1~200。

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

cpu_total
Webhook

string

否

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

N 的取值范围：1~200。

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

http://www.aliyun.com
Escalations.Warn.Threshold

string

否

警告级别报警阈值。

N 的取值范围：1~200。

说明

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

30
Namespace

string

否

云产品的命名空间。

N 的取值范围：1~200。

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

acs_ecs_dashboard
Period

integer

否

监控数据的统计周期。

N 的取值范围：1~200。

说明

设置为 300 秒，表示每 300 秒统计一次监控值。如果监控数据每分钟上报一次，则会统计 5 分钟的值（平均值、最大值、最小值）。因为该统计周期可能会造成非您期望的报警，所以目前不建议您单独设置该参数。

60
RuleName

string

否

报警规则名称。

N 的取值范围：1~200。

Rule_123
Escalations.Critical.Times

integer

否

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

N 的取值范围：1~200。

说明

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

2
Selector

string

否

Dimension 扩展字段的选项。

N 的取值范围：1~200。

例如：报警模板被应用到了一个应用分组中，当该参数设置为{"disk":"/"}，监控项（MetricName）设置为DiskUtilization时，表示关联报警模板的应用分组中所有实例的磁盘根分区（"/") 被关联到了对应报警规则中。

说明

关于扩展字段选项的取值，请参见 DescribeMetricRuleTemplateAttribute 。

{"disk":"/"}
Escalations.Info.Statistics

string

否

普通级别报警统计方法。

N 的取值范围：1~200。

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

说明

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

Average
Escalations.Warn.Times

integer

否

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

N 的取值范围：1~200。

说明

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

1
Escalations.Info.ComparisonOperator

string

否

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

  • GreaterThanOrEqualToThreshold：大于等于。

  • GreaterThanThreshold：大于。

  • LessThanOrEqualToThreshold：小于等于。

  • LessThanThreshold：小于。

  • NotEqualToThreshold：不等于。

  • GreaterThanYesterday：同比昨天时间上涨。

  • LessThanYesterday：同比昨天时间下降。

  • GreaterThanLastWeek：同比上周同一时间上涨。

  • LessThanLastWeek：同比上周同一时间下降。

  • GreaterThanLastPeriod：环比上周期上涨。

  • LessThanLastPeriod：环比上周期下降。

N 的取值范围：1~200。

说明

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

GreaterThanOrEqualToThreshold
Category

string

否

云产品名称缩写。

N 的取值范围：1~200。

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

ecs
Escalations.Critical.Threshold

string

否

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

N 的取值范围：1~200。

说明

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

30
Escalations.Critical.Statistics

string

否

紧急级别报警统计方法。

N 的取值范围：1~200。

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

说明

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

Average
Escalations.Critical.ComparisonOperator

string

否

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

  • GreaterThanOrEqualToThreshold：大于等于。

  • GreaterThanThreshold：大于。

  • LessThanOrEqualToThreshold：小于等于。

  • LessThanThreshold：小于。

  • NotEqualToThreshold：不等于。

  • GreaterThanYesterday：同比昨天时间上涨。

  • LessThanYesterday：同比昨天时间下降。

  • GreaterThanLastWeek：同比上周同一时间上涨。

  • LessThanLastWeek：同比上周同一时间下降。

  • GreaterThanLastPeriod：环比上周期上涨。

  • LessThanLastPeriod：环比上周期下降。

N 的取值范围：1~200。

说明

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

GreaterThanOrEqualToThreshold
Escalations.Warn.ComparisonOperator

string

否

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

  • GreaterThanOrEqualToThreshold：大于等于。

  • GreaterThanThreshold：大于。

  • LessThanOrEqualToThreshold：小于等于。

  • LessThanThreshold：小于。

  • NotEqualToThreshold：不等于。

  • GreaterThanYesterday：同比昨天时间上涨。

  • LessThanYesterday：同比昨天时间下降。

  • GreaterThanLastWeek：同比上周同一时间上涨。

  • LessThanLastWeek：同比上周同一时间下降。

  • GreaterThanLastPeriod：环比上周期上涨。

  • LessThanLastPeriod：环比上周期下降。

N 的取值范围：1~200。

说明

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

GreaterThanOrEqualToThreshold
Escalations.Info.Times

integer

否

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

N 的取值范围：1~200。

说明

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

1
Escalations.Warn.Statistics

string

否

警告级别报警统计方法。

N 的取值范围：1~200。

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

说明

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

Average

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

返回参数

名称

类型

描述

示例值

object

Code

integer

状态码。

说明

200 表示成功。

200
Message

string

错误信息。

The Request is not authorization.
RequestId

string

请求 ID。

9E07117F-F6AE-4F1C-81E8-36FBB4892235
Success

boolean

操作是否成功。取值：

  • true：成功。

  • false：失败。

true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "9E07117F-F6AE-4F1C-81E8-36FBB4892235",
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidQueryParameter %s
400 %s %s
401 AccessDeniedException You donot have sufficient access to perform this action.
412 %s %s
500 InternalFailure %s
402 LimitExceeded The quota for this customer had been reached.
403 InvalidClientTokenId The X.509 certificate or cms access key ID provided does not exist in our records.
206 %s %s
404 %s %s
503 %s %s
406 %s %s
429 Throttli∂ngException The request was denied due to request throttling.
409 %s %s

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

变更历史

更多信息，参考变更详情。

上一篇：DeleteMetricRuleTemplate - 删除报警规则模板下一篇：DescribeMetricRuleTemplateAttribute - 查询报警模板详情