文档

CreateMetricRuleTemplate - 创建报警模板

更新时间:

调用CreateMetricRuleTemplate接口创建报警模板。

调试

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

授权信息

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

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

请求参数

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

报警模板名称。

Template1
Descriptionstring

报警模板描述信息。

ECS_Template1
AlertTemplatesobject []

报警模板列表。

Escalations.Info.Thresholdstring

普通级别报警阈值。

N 的取值范围:1~200。

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

监控项名称。

N 的取值范围:1~200。

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

cpu_total
Webhookstring

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

N 的取值范围:1~200。

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

http://ww.aliyun.com
Escalations.Warn.Thresholdstring

警告级别报警阈值。

N 的取值范围:1~200。

说明 报警级别 Critical(严重)、Warn(警告)或 Info(信息)至少设置一个,且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。
30
Namespacestring

云产品的数据命名空间。

N 的取值范围:1~200。

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

acs_ecs_dashboard
Periodinteger

监控数据的聚合周期。单位:秒。

默认为监控项对应的最小周期,通常不需要指定。

N 的取值范围:1~200。

60
RuleNamestring

报警规则名称。

N 的取值范围:1~200。

ECS_Rule1
Escalations.Critical.Timesinteger

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

N 的取值范围:1~200。

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

Dimension 扩展字段的选项。

N 的取值范围:1~200。

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

说明 关于扩展字段选项的取值,请参见 DescribeMetricRuleTemplateAttribute
{"disk":"/"}
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 必须同时设置。
1
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
Categorystring

云产品名称缩写。

N 的取值范围:1~200。

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

ecs
Escalations.Critical.Thresholdstring

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

N 的取值范围:1~200。

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

紧急级别报警统计方法。

N 的取值范围:1~200。

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

说明 报警级别 Critical(严重)、Warn(警告)或 Info(信息)至少设置一个,且该报警级别中的参数 Statistics、ComparisonOperator、Threshold 和 Times 必须同时设置。
Average
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.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
Escalations.Warn.Statisticsstring

警告级别报警统计方法。

N 的取值范围:1~200。

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

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

返回参数

名称类型描述示例值
object

返回数据。

Codeinteger

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The Request is not authorization.
RequestIdstring

请求 ID。

9763ED1A-4D09-41BF-851E-310421750204
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Idlong

报警模板 ID。

12345

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "9763ED1A-4D09-41BF-851E-310421750204",
  "Success": true,
  "Id": 12345
}

错误码

HTTP status code错误码错误信息
206%s%s
400InvalidQueryParameter%s
401AccessDeniedExceptionYou donot have sufficient access to perform this action.
402LimitExceededThe quota for this customer had been reached.
403InvalidClientTokenIdThe X.509 certificate or cms access key ID provided does not exist in our records.
409ResourceConflictConcurrent modification of resources.
409ResourceExistResources already exist.
412ResourcesOverLimitResources over limit.
429Throttli∂ngExceptionThe request was denied due to request throttling.
500InternalFailure%s

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)