调用CreateMetricRuleTemplate接口创建报警模板。
本文将提供一个示例,创建报警模板Template_test
,并为报警模板创建一条报警规则,报警对象为云服务器ECS的监控项cpu_total
,报警规则名称为Rule_test
,报警级别为Critical
,报警统计方法为Average
,报警阈值比较符为GreaterThanOrEqualToThreshold
,报警阈值为90
,报警重试次数为3
。返回结果显示,创建报警模板成功,报警模板ID为12345
。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateMetricRuleTemplate |
要执行的操作,取值:CreateMetricRuleTemplate。 |
Name | String | 是 | Template_test |
报警模板名称。 |
AlertTemplates.N.MetricName | String | 是 | cpu_total |
监控项名称。N的取值范围:1~200。 关于如何获取监控项名称,请参见DescribeMetricMetaList或云产品监控项。 |
AlertTemplates.N.RuleName | String | 是 | Rule_test |
报警规则名称。N的取值范围:1~200。 |
AlertTemplates.N.Category | String | 是 | ecs |
阿里云产品名称或产品规格缩写。N的取值范围:1~200。取值:
|
AlertTemplates.N.Namespace | String | 是 | acs_ecs_dashboard |
云产品的命名空间。N的取值范围:1~200。 关于如何获取云产品的命名空间,请参见DescribeMetricMetaList或云产品监控项。 |
Description | String | 否 | ECS_Template1 |
报警模板描述信息。 |
AlertTemplates.N.Period | Integer | 否 | 60 |
监控数据的上报周期。N的取值范围:1~200。
|
AlertTemplates.N.Selector | String | 否 | {"disk":"/"} |
扩展字段选项。N的取值范围:1~200。 |
AlertTemplates.N.Escalations.Critical.Statistics | String | 否 | Average |
Critical级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。N的取值范围:1~200。取值:
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Escalations.Critical.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold |
Critical级别阈值比较符。N的取值范围:1~200。取值:
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Escalations.Critical.Threshold | String | 否 | 90 |
Critical级别报警阈值。N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Escalations.Critical.Times | Integer | 否 | 3 |
Critical级别报警重试次数。N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Escalations.Warn.Statistics | String | 否 | Average |
Warn级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。N的取值范围:1~200。取值:
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Escalations.Warn.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold |
Warn级别阈值比较符。N的取值范围:1~200。取值:
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Escalations.Warn.Threshold | String | 否 | 90 |
Warn级别报警阈值。N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Escalations.Warn.Times | Integer | 否 | 3 |
Warn级别报警重试次数。N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Escalations.Info.Statistics | String | 否 | Average |
Info级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。N的取值范围:1~200。取值:
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Escalations.Info.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold |
Info级别阈值比较符。N的取值范围:1~200。取值:
说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Escalations.Info.Threshold | String | 否 | 90 |
Info级别报警阈值。N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Escalations.Info.Times | Integer | 否 | 3 |
Info级别报警重试次数。N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数
Statistics 、ComparisonOperator 、Threshold 和Times 必须同时设置。
|
AlertTemplates.N.Webhook | String | 否 | http://ww.aliyun.com |
报警发生回调时的URL地址。N的取值范围:1~200。 填写公网可访问的URL地址,云监控会将报警信息通过POST请求推送到该地址,目前仅支持HTTP协议。 |
关于公共请求参数的详情,请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 9763ED1A-4D09-41BF-851E-310421750204 |
请求ID。 |
Success | Boolean | true |
操作是否成功。取值:
|
Code | Integer | 200 |
状态码。 说明 200表示成功。
|
Id | Long | 12345 |
报警模板ID。 |
Message | String | The Request is not authorization. |
错误信息。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateMetricRuleTemplate
&Name=Template_test
&AlertTemplates.1.MetricName=cpu_total
&AlertTemplates.1.RuleName=Rule_test
&AlertTemplates.1.Category=ecs
&AlertTemplates.1.Namespace=acs_ecs_dashboard
&<公共请求参数>
正常返回示例
XML
格式
<CreateMetricRuleTemplateResponse>
<RequestId>9763ED1A-4D09-41BF-851E-310421750204</RequestId>
<Id>12345</Id>
<Success>true</Success>
<Code>200</Code>
</CreateMetricRuleTemplateResponse>
JSON
格式
{
"RequestId": "9763ED1A-4D09-41BF-851E-310421750204",
"Id": 12345,
"Success": true,
"Code": 200
}
错误码
访问错误中心查看更多错误码。