调用CreateMetricRuleTemplate接口创建报警模板。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateMetricRuleTemplate | 要执行的操作,取值:CreateMetricRuleTemplate。 |
Name | String | 是 | Template1 | 报警模板名称。 |
Description | String | 否 | ECS_Template1 | 报警模板描述信息。 |
AlertTemplates.N.Escalations.Info.Threshold | String | 否 | 20 | 普通级别报警阈值。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
AlertTemplates.N.MetricName | String | 是 | cpu_total | 监控项名称。 N的取值范围:1~200。 关于如何获取监控项,请参见DescribeMetricMetaList或云产品监控项。 |
AlertTemplates.N.Webhook | String | 否 | http://ww.aliyun.com | 报警发生回调时的URL地址。 N的取值范围:1~200。 填写公网可访问的URL地址,云监控会将报警信息通过POST请求推送到该地址,目前仅支持HTTP协议。 |
AlertTemplates.N.Escalations.Warn.Threshold | String | 否 | 30 | 警告级别报警阈值。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
AlertTemplates.N.Namespace | String | 是 | acs_ecs_dashboard | 云产品的数据命名空间。 N的取值范围:1~200。 关于如何获取云产品的数据命名空间,请参见DescribeMetricMetaList或云产品监控项。 |
AlertTemplates.N.Period | Integer | 否 | 60 | 监控数据的聚合周期。单位:秒。 默认为监控项对应的最小周期,通常不需要指定。 N的取值范围:1~200。 |
AlertTemplates.N.RuleName | String | 是 | ECS_Rule1 | 报警规则名称。 N的取值范围:1~200。 |
AlertTemplates.N.Escalations.Critical.Times | Integer | 否 | 3 | 发送紧急报警通知需要监控指标达到报警阈值的次数。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
AlertTemplates.N.Selector | String | 否 | {"disk":"/"} | Dimension扩展字段的选项。 N的取值范围:1~200。 例如:报警模板被应用到了一个应用分组中,当该参数设置为 说明 关于扩展字段选项的取值,请参见DescribeMetricRuleTemplateAttribute。 |
AlertTemplates.N.Escalations.Info.Statistics | String | 否 | Average | 普通级别报警统计方法。 N的取值范围:1~200。 该参数的取值由指定云产品的 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
AlertTemplates.N.Escalations.Warn.Times | Integer | 否 | 1 | 发送警告报警通知需要监控指标达到报警阈值的次数。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
AlertTemplates.N.Escalations.Info.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold | 普通级别阈值比较符。取值:
N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
AlertTemplates.N.Category | String | 是 | ecs | 云产品名称缩写。 N的取值范围:1~200。 关于如何获取云产品名称缩写,请参见DescribeProjectMeta接口的返回参数 |
AlertTemplates.N.Escalations.Critical.Threshold | String | 否 | 30 | 触发紧急级别报警通知的阈值。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
AlertTemplates.N.Escalations.Critical.Statistics | String | 否 | Average | 紧急级别报警统计方法。 N的取值范围:1~200。 该参数的取值由指定云产品的 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
AlertTemplates.N.Escalations.Critical.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold | 紧急级别阈值比较符。取值:
N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
AlertTemplates.N.Escalations.Warn.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold | 警告级别阈值比较符。取值:
N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
AlertTemplates.N.Escalations.Info.Times | Integer | 否 | 1 | 发送普通报警通知需要监控指标达到报警阈值的次数。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
AlertTemplates.N.Escalations.Warn.Statistics | String | 否 | Average | 警告级别报警统计方法。 N的取值范围:1~200。 该参数的取值由指定云产品的 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | Integer | 200 | 状态码。 说明 200表示成功。 |
Message | String | The Request is not authorization. | 错误信息。 |
RequestId | String | 9763ED1A-4D09-41BF-851E-310421750204 | 请求ID。 |
Success | Boolean | true | 操作是否成功。取值:
|
Id | Long | 12345 | 报警模板ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateMetricRuleTemplate
&Name=Template1
&AlertTemplates.1.MetricName=cpu_total
&AlertTemplates.1.RuleName=我的CPU监控
&AlertTemplates.1.Category=ecs
&AlertTemplates.1.1amespace=acs_ecs_dashboard
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateMetricRuleTemplateResponse>
<RequestId>9763ED1A-4D09-41BF-851E-310421750204</RequestId>
<Id>12345</Id>
<Success>true</Success>
<Code>200</Code>
</CreateMetricRuleTemplateResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "9763ED1A-4D09-41BF-851E-310421750204",
"Id" : 12345,
"Success" : true,
"Code" : 200
}
错误码
访问错误中心查看更多错误码。