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

调试

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

请求参数

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

系统规定参数。取值:ApplyMetricRuleTemplate。

GroupId Long 12345

应用分组ID。

TemplateIds String 123

报警模板ID。

ApplyMode String GROUP_INSTANCE_FIRST
  • GROUP_INSTANCE_FIRST:实例分组优先, 即应用报警模板时,以分组实例优先,如果分组中不存在这种实例则忽略模板中的规则。
  • ALARM_TEMPLATE_FIRST:模板实例优先,即应用报警模板时,不管分组中是否存在这种实例,都创建出这种规则。
EnableEndTime Long 23

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

EnableStartTime Long 00

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

NotifyLevel Long 3

报警的级别。

  • 2:电话+短信+邮箱+旺旺+钉钉机器人。
  • 3:短信+邮箱+旺旺+钉钉机器人。
  • 4:短信+邮箱+旺旺+钉钉机器人。
SilenceTime Long 86400

通道沉默周期,单位为秒。默认为86400秒(1天)。

说明 当监控数据持续超过报警规则阈值时,每个沉默周期内只发送1次报警通知。
Webhook String http://www.aliyun.com

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

返回数据

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

状态码。

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

请求ID。

Success Boolean true

请求是否成功。

Resource

影响的资源。

AlertResults Array

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

Code String 200

状态码。

说明 状态码为200表示成功。
GroupId Long 123456

应用分组ID。

Message String success

错误信息。

RuleId String applyTemplate12345-321

报警规则ID。

RuleName String ruleName1

报警规则名称。

Success Boolean true

请求是否成功。

GroupId Long 12345

应用分组ID。

Message String success

错误信息。

示例

请求示例


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

正常返回示例

XML 格式

<RequestId>3F897F3C-020A-4993-95B4-63ABB84F83E6</RequestId>
<Resource>
    <AlertResults>
        <RuleName>ruleName1</RuleName>
        <Code>200</Code>
        <Success>true</Success>
        <RuleId>applyTemplate12345-321</RuleId>
        <GroupId>123456</GroupId>
    </AlertResults>
    <AlertResults>
        <RuleName>ruleName2</RuleName>
        <Code>200</Code>
        <Success>true</Success>
        <RuleId>applyTemplate12345-322</RuleId>
        <GroupId>123457</GroupId>
    </AlertResults>
    <AlertResults>
        <RuleName>ruleName3</RuleName>
        <Code>200</Code>
        <Success>true</Success>
        <RuleId>applyTemplate12345-323</RuleId>
        <GroupId>123459</GroupId>
    </AlertResults>
    <GroupId>12345</GroupId>
</Resource>
<ErrorCode>200</ErrorCode>
<Success>true</Success>

JSON 格式

{
	"Resource":{
		"AlertResults":[
			{
				"RuleId":"applyTemplate12345-321",
				"Success":true,
				"RuleName":"ruleName1",
				"GroupId":123456,
				"Code":200
			},
			{
				"RuleId":"applyTemplate12345-322",
				"Success":true,
				"RuleName":"ruleName2",
				"GroupId":123457,
				"Code":200
			},
			{
				"RuleId":"applyTemplate12345-323",
				"Success":true,
				"RuleName":"ruleName3",
				"GroupId":123459,
				"Code":200
			}
		],
		"GroupId":12345
	},
	"RequestId":"3F897F3C-020A-4993-95B4-63ABB84F83E6",
	"Success":true,
	"ErrorCode":200
}

错误码

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