获取告警规则列表。

请求说明

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

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

调试

API Explorer

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

请求参数

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

AlertingRuleFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["90b5a3da-3464-4718-92e4***"]	按告警规则 ID 过滤，精确查询。
Name	String	否	alert-rule-demo	按告警规则名称过滤，模糊查询。
Type	String	否	vmp/PromQL	按告警规则类型过滤，精确查询。
WorkspaceId	String	否	e28ae750-bbb8-4ff4-abf4***	按工作区 ID 过滤，精确查询。
NotifyPolicyIds	Array of String	否	["e28ae750-bbb8-4ff4-abf4***"]	按通知策略 ID 过滤，精确查询。
NotifyGroupPolicyIds	Array of String	否	["e28ae750-bbb8-4ff4-abf4***"]	按聚合策略 ID 过滤，精确查询。
Status	String	否	Running	按告警规则状态过滤： Running：监控中 Disabled：已停用

请求示例

返回参数

AlertingRule

参数	类型	示例值	描述
Id	String	90b5a3da-3464-4718-92e4-039bf41d3cff	告警规则 ID。
CreateTime	String	2020-01-01T00:00:00Z	告警规则创建时间。
UpdateTime	String	2020-01-01T00:00:00Z	告警规则更新时间。
Name	String	alert-rule-demo	告警规则名称。
Description	String	this is a alert rule demo	告警规则描述信息。
Type	String	vmp/PromQL	告警规则类型，固定取值为vmp/PromQL。
Query	Object of AlertingRuleQuery	-	告警配置。
Levels	Array of AlertingRuleLevel	-	告警等级。
NotifyPolicyId	String	e28ae750-bbb8-4ff4-abf4***	告警通知策略 ID。
NotifyGroupPolicyId	String	e28ae750-bbb8-4ff4-abf4***	告警聚合策略 ID。
Status	String	Running	告警规则状态： Running：监控中 Disabled：已停用
Labels	Array of TemplateKV	-	附加到告警的标签。
Annotations	Array of TemplateKV	-	附加到告警的注释。

AlertingRuleQuery

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	告警规则阈值。

TemplateKV

返回示例

错误码

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

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