文档

ApplyMetricRuleTemplate - 应用报警模板至应用分组

更新时间:

调用ApplyMetricRuleTemplate接口将报警模板应用到应用分组并生成报警规则。

接口说明

本文将提供一个示例,将报警模板700****应用到应用分组123456,生成报警规则的 ID 为applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****,名称为test123

调试

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

授权信息

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

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

请求参数

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

通道沉默周期。单位:秒。默认值:86400。

说明 当监控数据持续超过报警规则阈值时,每个沉默周期内只发送一次报警通知。
86400
GroupIdlong

应用分组 ID。

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

123456
TemplateIdsstring

报警模板 ID。

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

700****
EnableStartTimelong

报警生效的开始时间。取值范围:00~23,表示 00:00 到 23:00。

00
EnableEndTimelong

报警生效的结束时间。取值范围:00~23,表示 00:59 到 23:59。

23
NotifyLevellong

报警通知方式。取值:

  • 2:电话+短信+邮箱+旺旺+钉钉机器人。

  • 3:短信+邮箱+旺旺+钉钉机器人。

  • 4:旺旺+钉钉机器人。

4
ApplyModestring

模板应用方式。取值:

  • GROUP_INSTANCE_FIRST:应用分组实例优先。应用报警模板时,以应用分组实例优先,如果应用分组中不存在该实例,则忽略模板中的规则。

  • ALARM_TEMPLATE_FIRST:报警模板实例优先。应用报警模板时,不管应用分组中是否存在该实例,都创建报警规则。

GROUP_INSTANCE_FIRST
Webhookstring

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

https://www.aliyun.com
AppendModestring

模板应用策略。取值:

  • all:删除已选择分组上所有通过报警模板创建的规则,然后按模板创建新的报警规则(默认值)。

  • append:删除已选择分组上通过该报警模板创建的规则,然后按当前模板创建新的报警规则。

all

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

返回参数

名称类型描述示例值
object
Codeinteger

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The specified resource is not found.
RequestIdstring

请求 ID。

3F897F3C-020A-4993-95B4-63ABB84F83E6
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Resourceobject

报警规则影响的资源。

GroupIdlong

应用分组 ID。

123456
AlertResultsobject []

生成报警规则的详细结果。

Codestring

状态码。

说明 200 表示成功。
200
Messagestring

返回信息。

alert rule is creating, please wait a few minutes.
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
RuleNamestring

报警规则名称。

test123
RuleIdstring

报警规则 ID。

applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "The specified resource is not found.",
  "RequestId": "3F897F3C-020A-4993-95B4-63ABB84F83E6",
  "Success": true,
  "Resource": {
    "GroupId": 123456,
    "AlertResults": [
      {
        "Code": "200",
        "Message": "alert rule is creating, please wait a few minutes.",
        "Success": true,
        "RuleName": "test123",
        "RuleId": "applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400ParameterInvalidIllegal parameters.
403AccessForbiddenUser not authorized to operate on the specified resource.
404ResourceNotFound%s
500InternalErrorThe request processing has failed due to some unknown error.

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

变更历史

变更时间变更内容概要操作
2024-02-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:AppendMode