获取告警规则模板列表，仅包含最新版本。

请求说明

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

请求方式：POST

请求地址：https://vmp.cn-beijing.volcengineapi.com?Action=ListAlertingRuleTemplates&Version=2021-03-03

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListAlertingRuleTemplates	接口名称。当前 API 的名称为 ListAlertingRuleTemplates。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
PageNumber	Long	否	1	当前页数，最小值或默认值均为 1。
PageSize	Long	否	10	单页数量: 取值范围为 0～100。默认值为 10。
Filter	Object of AlertingRuleTemplateFilter	否	-	告警规则模板过滤条件。
SortBy	String	否	CreatedAt	查询结果是否进行排序，取值：配置该字段为CreatedAt时，表示进行排序。不配置该字段，表示不进行排序。
SortOrder	String	否	Asc	查询结果的排序原则，取值： Asc：表示按照升序排序。 Desc：表示按照降序排序。

AlertingRuleTemplateFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["e28-**-abf4**"]	按告警规则模板 ID 过滤，精确查询。
Categories	Array of String	否	["VKE"]	按告警规则模板产品分类过滤，精确查询。例如：配置为VKE表示查询容器服务（VKE）的告警模板。

请求示例

返回参数

参数	类型	示例值	描述
Total	Long	100	符合筛选条件的告警规则模板总数。
Items	Array of AlertingRuleTemplate	-	告警规则模板列表。

AlertingRuleTemplate

参数	类型	示例值	描述
Id	String	e28a-**-abf4*	告警规则模板 ID。
Name	String	test	告警规则模板名称。
Description	String	-	告警规则模板描述信息。
Items	Array of AlertingRuleTemplateItem	-	告警规则模板列表。
Labels	Array of TemplateKV	-	告警规则模版全局标签，可附加到告警的 alert 中，优先级比模版中单条规则配置的优先级高。
Version	String	1.0.1	告警规则模板的版本。
Category	String	VKE	告警规则模板所属产品。
Variables	Array of Variable	-	告警规则中的变量。
CreateTime	String	2020-01-01T00:00:00Z	告警规则模板创建时间。
UpdateTime	String	2020-01-01T00:00:00Z	告警规则模板更新时间。

AlertingRuleTemplateItem

参数	类型	示例值	描述
Id	Long	1	告警规则模板项序号。
Name	String	test5	告警规则模板项名称。
Labels	Array of TemplateKV	-	附加到告警规则的标签。
Levels	Array of AlertingRuleLevel	-	告警等级。
PromQL	String	my_metrics{cluster=~"$Cluster"}	告警规则 PromQL。
Annotations	Array of TemplateKV	-	附加到告警规则的注释。
Description	String	-	告警规则描述。

TemplateKV

参数	类型	示例值	描述
Name	String	key1	标签的 Key。
Value	String	value1	标签的 Value，配置为空时表示将该键删除。

Variable

参数	类型	示例值	描述
Id	Long	1	变量 ID。
Name	String	Cluster	变量名称，该名称会在 PromQL 中使用。说明变量用于对监控数据中的云产品资源对象进行更细粒度的筛选，例如：在 VKE 产品中，您可以通过变量选择 VKE 集群或命名空间。变量名称首字母必须大写，采用驼峰格式。例如ClusterNode。
Type	String	Query	变量类型，取值： Query：PromQL 动态变量，该类型的变量仅能定义变量名称，无法直接定义变量值。例如：在集群的监控指标中，集群 ID、命名空间名称等，均为动态值。动态变量的值可以通过指定 PromQL 语句和正则表达式来获取。 Custom：固定值变量，用于匹配固定的变量值。例如：在集群的监控指标中，工作负载的类型是固定的，包括 Depolyment、StatefulSet、DaemonSet 等，可以直接指定。
Alias	String	test6	变量别名，展示在变量选择器中。
Multi	Boolean	true	变量值是否支持多选，取值： true：支持多选。 false：不支持多选。
Query	String	kube_pod_info	变量值查询语句。仅适用于 Query 类型的变量。
Regex	String	/.pod="(.?)".*	提取变量值的正则表达式。仅适用于 Query 类型的变量。
Values	Array of String	Depolyment	变量的固定值。仅适用于 Custom 类型的变量。
Default	Array of String	demo	变量的默认值，当配置为空时：若IncludeAll为False时，表示不选。若IncludeAll为True时，表示全选。
QueryType	String	queryResult	变量 Query 查询类型。仅适用于 Query 类型的变量。
IncludeAll	Boolean	true	配置变量时，是否支持全选选项。取值： true：支持全选选项。 false：不支持全选选项。

AlertingRuleLevel

参数	类型	示例值	描述
Level	String	P0	告警规则等级，当前支持 P0、P1 或 P2。
For	String	5m	告警持续时间，取值： 0s：立即触发 1m：1 分钟 2m：2 分钟 5m：5 分钟 10m：10 分钟
Comparator	String	>	告警规则比较条件，取值： >：大于 >=：大于等于 <：小于 <=：小于等于 ==：等于 !=：不等于
Threshold	Double	1.0	告警规则阈值。

返回示例

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
403	ProductUnsubscribed	You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service	当前账号未订阅 VMP 服务。
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	输入不合法，如工作区名称不合法等。