文档中心

云监控

告警模板

CreateAlertTemplate

CreateAlertTemplate

创建告警模版。

使用限制

每个账号，最多允许创建 1000 个告警模版。

每个告警模版中，最多允许包含 100 个告警策略。

请求说明

云监控已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地选择最合适的接入点。

请求方式：POST

请求地址：https://cloudmonitor.cn-beijing.volcengineapi.com?Action=CreateAlertTemplate&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateAlertTemplate	接口名称。当前 API 的名称为 CreateAlertTemplate。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 2018-01-01。
Name	String	是	alert-template-demo	告警模版名称。字符串形式，支持中文、英文大小写和特殊字符。不能以数字、中划线-，特殊字符开头。长度限制为 1～128 字符。
Description	String	否	this is an alert template demo	告警模版描述信息。字符串形式，支持中文、英文大小写和特殊字符。长度限制为 0～255 字符。
NoData	Object of NoData	否	-	无数据告警配置。
NotifyMode	String	是	rule	告警发送聚合策略。 rule：（默认）基于规则进行告警聚合。 Resource：基于规则和资源进行告警聚合。
RecoveryNotify	Object of RecoveryNotify	否	-	告警恢复通知。
SilenceTime	Integer	是	5	告警通知周期。单位为分钟。支持 5、10、15、30、60、180、360、720、1440。
TemplateRules	Array of TemplateRule	是	-	告警模版配置详情。

NoData

参数	类型	是否必选	示例值	描述
Enable	Boolean	否	true	是否开启无数据告警。取值： true：开启无数据告警。 false：（默认）关闭无数据告警。
EvaluationCount	Integer	否	10	无数据告警触发阈值，如果在配置的阈值周期内检测无数据上报，则会触发无数据告警。当Enable配置为true时，该字段为必填。整数形式，取值范围为 3～20。
Level	String	否	notice	无数据告警级别。取值： critical：严重 warning：警告 notice：通知

RecoveryNotify

参数	类型	是否必选	示例值	描述
Enable	Boolean	否	true	是否开启告警恢复通知。取值： true：（默认）开启告警恢复通知。 false：关闭告警恢复通知。

TemplateRule

参数	类型	是否必选	示例值	描述
Name	String	是	CPU useage	告警规则名称。字符串形式，支持中文、英文大小写和特殊字符。不能以数字、中划线-，特殊字符开头。长度限制为 1～64 字符。说明告警模版名称和该名称拼接获得模版生成的告警规则名称。
Namespace	String	是	VCM_ECS	此策略监控指标所属的云产品。详情请参见云产品监控指标下各产品的 Namespace。
SubNamespace	String	是	GPU	此策略引用指标所属的维度。详情请参见云监控指标查询下各产品的 SubNamespace。
EvaluationCount	Integer	是	1	触发告警需要持续的周期。单位为分钟。取值为 1、3、5、10、15、30、60、120。
LevelConditions	Array of LevelCondition	是	-	告警分级。
ConditionOperator	String	否	&&	多指标判定条件。 &&：多个指标同时成立才判定为触发告警。 \|\|：任意指标满足条件就判定为触发告警。
MultipleConditions	Boolean	否	true	告警策略是否用多指标。 true：多指标 false：（默认）单指标
NoData	Object of NoData	否	-	如果内层开启了NoData, 则默认使用内层NoData, 否则继承外层NoData
EvaluationInterval	Integer	否	1	检查周期，用于实现 M 个周期 N 次告警。其中，EvaluationInterval 表示 M，EvaluationCount 表示 N。 EvaluationInterval=CheckInterval*EvaluationCount，若留空不配置，默认使用 EvaluationCount 的值。

LevelCondition

参数	类型	是否必选	示例值	描述
Level	String	否	warning	告警通知等级，取值： notice：通知 warning：警告 critical：严重 recovery：恢复
Conditions	Array of RuleCondition	否	-	告警分级配置。

RuleCondition

参数	类型	是否必选	示例值	描述
MetricName	String	否	Instance_CpuBusy	监控指标的名称。详情请参见云监控指标查询下各产品的 MetricName。
Statistics	String	否	avg	统计方法，取值： avg：平均值。 max：最大值。 min：最小值。说明统计方法会应用到检测时间段内的数据上。例如，默认每次检测数据的时间跨度是 1 分钟，如果统计方法为 avg，那就是对 1 分钟内的数据取平均值。
ComparisonOperator	String	否	>	比较符号。支持普通阈值告警： >、>=、<、<=、!=、= ，以及以下同环比告警： last_period_increase_pct：环比上周期上涨。 last_period_decrease_pct：环比上周起下降。 last_period_abs_pct：环比上周期上涨或下降。 last_day_increase_pct：同比昨天同一时段上涨。 last_day_decrease_pct：同比昨天同一时段下降。 last_day_abs_pct：同比昨天同一时段上涨或下降。 last_week_increase_pct：同比上周同一时段上涨。 last_week_decrease_pct：同比上周同一时段下降。 last_week_abs_pct：同比上周同一时段上涨或下降。
Threshold	String	否	100	指标阈值。支持输入正数或 0。最多支持三位小数。
MetricUnit	String	否	Percent	监控指标的单位。详情请参见云监控指标查询下各产品的 MetricUnit。说明同环比告警，MetricUnit 需要填写为 "Percent"。 MetricUnit 中是否带有 IEC 表示不同的进位：带有 IEC：进位是 1024 不带 IEC：进位是 1000
EvaluationWindow	Integer	否	1	统计时间窗口，即告警统计数据的周期。

请求示例

返回参数

参数	类型	示例值	描述
Data	String	1354766247190******	告警模版 ID。

返回示例

错误码

本接口无特有的错误码。更多信息请参见错误码。

最近更新时间：2026.08.11 20:28:02

这个页面对您有帮助吗？

有用

有用

无用

无用