获取告警静默策略。

请求说明

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

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

调试

API Explorer

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

请求参数

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

SilencePolicyFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["e28ae750-bbb8-4ff4-abf4***"]	按告警静默策略 ID 过滤，精确查询。
Name	String	否	test	按告警静默策略名称过滤，模糊查询。
Status	String	否	Disabled	按告警静默策略状态过滤，取值： Active：静默策略处在生效时间段未过期，且未被关闭。 Disabled：已禁用的静默策略。 Expired：静默策略未被禁用，但静默策略的生效时间已过，策略已失效。如果不更新生效时间段，则该策略不会再被触发。
Sources	Array of String	否	General	按告警静默策略来源过滤。取值： General：通过 OpenAPI 或控制台创建。 LarkBot：通过飞书应用机器人卡片创建。详情请参见使用飞书应用机器人接收告警通知。

请求示例

返回参数

SilencePolicy

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4***	告警静默策略 ID。
Name	String	test	告警静默策略名称。
Source	String	General	告警静默策略来源。取值： General：通过 OpenAPI 或控制台创建。 LarkBot：通过飞书应用机器人卡片创建。
Status	String	Active	告警静默策略状态。取值： Active：静默策略处在生效时间段未过期，且未被关闭。 Disabled：已禁用的静默策略。 Expired：静默策略未被禁用，但静默策略的生效时间已过，策略已失效。如果不更新生效时间段，则该策略不会再被触发。
CreateTime	String	2020-01-01T00:00:00Z	告警静默策略的创建时间，RFC3339 格式。
UpdateTime	String	2020-01-01T00:00:00Z	告警静默策略的更新时间，RFC3339 格式。
Description	String	这是一段描述	告警静默策略的描述信息。
AutoDeleteTime	String	2020-01-01T00:00:00Z	告警静默策略自动删除时间。
TimeRangeMatchers	Array of TimeRangeMatcher	-	告警静默策略中的匹配时间。
MetricLabelMatchers	Array of Matcher	-	告警静默策略中的匹配 Label。

TimeRangeMatcher

Matcher

参数	类型	示例值	描述
Matchers	Array of LabelMatcher		Label 匹配器。其中，每个 LabelMatcher 数组最多填写 24 项。

PeriodicDate

参数	类型	示例值	描述
Time	String	20:00~21:12	时间周期。支持以英文逗号,分隔不同的时间段，如 20:00~21:12,22:00~23:12。最多可以配置 4 个时间段。
Weekday	String	1,3,5	周几，表示每周的固定时间。支持以英文逗号,分隔不同的时间段，如1,3,5表示周每周的周一、周三和周五。最多可以配置 7 个时间段。
DayOfMonth	String	2~3	月份内的日期，表示每月的固定时间。支持以英文逗号,分隔不同的时间段，如2~3表示每月的 2 号和 3 号。最多可以填 10 个时间段。

LabelMatcher

参数	类型	示例值	描述
Label	String	app	Label。
Value	String	test	Label Value。
Operator	String	Equal	操作符。可选值如下： Equal：相等 NotEqual：不相等 RegexpEqual：正则表达式匹配相等 RegexpNotEqual：正则表达式匹配不相等

返回示例

错误码

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

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