CreateSilencePolicy--托管 Prometheus-火山引擎

文档中心

立即注册

导航

CreateSilencePolicy

最近更新时间：2025.05.23 14:58:50首次发布时间：2024.08.16 17:03:02

创建告警静默策略。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=CreateSilencePolicy&Version=2021-03-03

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateSilencePolicy	接口名称。当前 API 的名称为 `CreateSilencePolicy`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Name	String	是	alert-silence-demo	告警静默策略名称。字符串形式，取值范围为 1～128 字符。支持中文，字母，数字，下划线和中划线。不能以数字，下划线开头。相同地域内名称唯一。
Description	String	否	这是一段描述	告警静默策略的描述信息。字符串形式，取值范围为 1～128 字符。支持任意 utf-8 字符。
LabelMatchers	Array of Array of LabelMatcher	是	-	使用告警中包含的 Label，匹配需要静默的告警事件。
TimeRangeMatchers	Array of TimeRangeMatcher	是	-	告警静默时间。

LabelMatcher

参数	类型	是否必选	示例值	描述
Label	String	是	app	需要屏蔽的告警资源标签，支持内置变量`__alerting_rule_id`，表示告警规则 ID。
Value	String	是	test	需要屏蔽的告警资源值，支持正则表达式。
Operator	String	否	Equal	匹配条件，取值：Equal、NotEqual、RegexpEqual 和 RegexpNotEqual，不填写时默认值为 Equal。

TimeRangeMatcher

参数	类型	是否必选	示例值	描述
Date	String	否	2006-01-02 15:04~2006-01-03 14:04	告警静默的时间段。用于配置指定时间段内的告警静默。
Location	String	是	Asia/Shanghai	时区。
PeriodicDate	Object of PeriodicDate	否	-	告警静默的周期。用于配置周期生效的告警静默。

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 个时间段。

请求示例

POST https://open.volcengineapi.com/?Action=CreateSilencePolicy&Version=2021-03-03
Content-Type: application/json
{
    "Name": "alert-silence-demo",
    "Description": "这是一段描述",
    "LabelMatchers": [
        [
            {
                "Label": "app",
                "Value": "test",
                "Operator": "Equal"
            }
        ]
    ],
    "TimeRangeMatchers": [
        {
            "Date": "2006-01-02 15:04~2006-01-03 14:04",
            "Location": "Asia/Shanghai",
            "PeriodicDate": {
                "Time": "20:00~21:12",
                "Weekday": "1,3,5",
                "DayOfMonth": "2~3"
            }
        }
    ]
}

返回参数

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	告警静默策略 ID。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateSilencePolicy",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
    }
}

错误码

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

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 the Volcengine Managed Service for Prometheus (VMP). Please go to the VMP console web page to subscribe to the service	当前账号未订阅 VMP 服务。
409	Conflict.Name	The specified name conflicts with existing {{resource}}.	指定的名称与已有资源重复。