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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ApplyMetricRuleTemplate

要执行的操作,取值:ApplyMetricRuleTemplate。

GroupId Long 12345

应用分组ID。

TemplateIds String 123

报警模板ID。

SilenceTime Long 86400

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

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

报警生效的起始周期。取值范围:00~23,表示00:00到23:00。

EnableEndTime Long 23

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

NotifyLevel Long 4

报警的级别。取值:

4:旺旺+钉钉机器人

ApplyMode String GROUP_INSTANCE_FIRST

模板应用方式。取值:

  • GROUP_INSTANCE_FIRST:应用分组实例优先。应用报警模板时,以应用分组实例优先,如果应用分组中不存在该实例,则忽略模板中的规则。
  • ALARM_TEMPLATE_FIRST:模板实例优先。应用报警模板时,不管应用分组中是否存在该实例,都创建出该规则。
Webhook String http://www.aliyun.com

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

返回数据

名称 类型 示例值 描述
Code Integer 200

状态码。

说明 200表示成功。
RequestId String 3F897F3C-020A-4993-95B4-63ABB84F83E6

请求ID。

Success Boolean true

操作是否成功。true表示成功,false表示失败。

Resource Struct

影响的资源。

AlertResults Array

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

Code String 200

状态码。

说明 200表示成功。
GroupId Long 123456

应用分组ID。

Message String The Request is not authorization.

错误信息。

RuleId String applyTemplate1234****

报警规则ID。

RuleName String ruleName1

报警规则名称。

Success Boolean true

操作是否成功。true表示成功,false表示失败。

GroupId Long 123456

应用分组ID。

Message String The Request is not authorization.

错误信息。

示例

请求示例

http(s)://[Endpoint]/?Action=ApplyMetricRuleTemplate
&GroupId=12345
&TemplateIds=123
&<公共请求参数>

正常返回示例

XML 格式

<ApplyMetricRuleTemplate>
		  <RequestId>3F897F3C-020A-4993-95B4-63ABB84F83E6</RequestId>
		  <Resource>
			    <GroupId>123456</GroupId>
			    <AlertResults>
				      <RuleId>applyTemplate1234****</RuleId>
				      <Code>200</Code>
				      <RuleName>ruleName1</RuleName>
				      <Success>true</Success>
				      <GroupId>123456</GroupId>
			    </AlertResults>
		  </Resource>
		  <Code>200</Code>
		  <Success>true</Success>
</ApplyMetricRuleTemplate>

JSON 格式

{
    "RequestId":"3F897F3C-020A-4993-95B4-63ABB84F83E6",
    "Resource":{
        "GroupId":"123456",
        "AlertResults":[
            {
                "RuleId":"applyTemplate1234****",
                "Code":"200",
                "RuleName":"ruleName1",
                "Success":"true",
                "GroupId":"123456"
            }]
    },
    "Code":"200",
    "Success":"true"
}

错误码

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