获取告警规则组列表。

请求说明

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

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

调试

API Explorer

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

请求参数

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

AlertingRuleGroupFilter

请求示例

返回参数

AlertingRuleGroup

参数	类型	示例值	描述
Id	String	421d-**-ba4d*	告警规则组 ID。
Name	String	test	告警规则组名称。
Items	Array of AlertingRuleGroupItem	-	关联的告警规则列表。
Variables	Array of VariableValue	-	变量配置。
CreateTime	String	2020-01-01T00:00:00Z	告警规则组创建时间。
UpdateTime	String	2020-01-01T00:00:00Z	告警规则组更新时间。
Description	String	-	告警规则组描述信息。
WorkspaceId	String	421d-**-ba4d**	工作区 ID。
NotifyPolicyId	String	421d-**-ba4d**	告警通知策略 ID。
NotifyPolicySource	String	VMP	告警通知策略来源。
NotifyGroupPolicyId	String	421d-**-ba4d**	告警聚合策略 ID。
AlertingRuleTemplateId	String	421d-**-ba4d**	关联的告警模板 ID。
NotifyGroupPolicySource	String	VMP	告警聚合策略来源。
AlertingRuleTemplateVersion	String	1.0.1	关联的告警模板版本。

AlertingRuleGroupItem

VariableValue

参数	类型	示例值	描述
Id	Long	1	变量 ID。可以使用 ListAlertingRuleTemplates 接口获取告警模版中的变量 ID。
Name	String	Cluster	Variable 名称。与 AlertingRuleTemplate.Variables 中的 Name 对应；升级或变量重排时可替代 ID 用于稳定匹配。
Values	Array of String	demo	变量的默认值，当配置为空时：若ListAlertingRuleTemplates接口中IncludeAll参数为False时，表示不选。若ListAlertingRuleTemplates接口中IncludeAll参数为True时，表示全选。

TemplateKV

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.	输入不合法，如工作区名称不合法等。
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	缺少必要的参数。