文档中心

托管 Prometheus

告警静默策略

UpdateSilencePolicy

更新告警静默策略。

请求说明

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

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateSilencePolicy	接口名称。当前 API 的名称为 UpdateSilencePolicy。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
Id	String	是	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	告警静默策略 ID。可以调用 ListSilencePolicies接口，获取告警静默策略 ID。
Name	String	否	alert-silence-demo	告警静默策略名称。字符串形式，取值范围为 1～128 字符。支持中文，字母，数字，下划线和中划线。不能以数字，下划线开头。相同地域内名称唯一。
Description	String	否	这是一段描述	告警策略的描述信息。字符串形式，取值范围为 1～128 字符。支持任意 utf-8 字符。
TimeRangeMatchers	Array of TimeRangeMatcher	否	-	告警静默时间。
MetricLabelMatchers	Array of Matcher	否		告警事件 Label 匹配器，最多允许填写 32 项，不同项之间遵循“或”关系。 Matcher 中的不同 LabelMatcher 间遵循“与”关系。。

TimeRangeMatcher

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

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：正则表达式匹配不相等

请求示例

POST https://vmp.cn-beijing.volcengineapi.com?Action=UpdateSilencePolicy&Version=2021-03-03​
Content-Type: application/json​
{​
    "Id": "e28xxxx0-bxxx-4ff4-axx4-1e0xxxx880xx",​
    "Name": "alert-silence-demo",​
    "Description": "Description",​
    "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"​
            }​
        }​
    ],​
    "MetricLabelMatchers": [​
        {​
            "Matchers": [​
                {​
                    "Label": "app",​
                    "Value": "test",​
                    "Operator": "Equal"​
                }​
            ]​
        }​
    ]​
}

返回参数

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

返回示例

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

错误码

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

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 服务。
404	NotFound.Id	The specified Contact/ContactGroup {{Id}} is not found.	未找到指定联系人/联系人组。
409	Conflict.Name	The specified name conflicts with existing {{resource}}.	指定的名称与已有资源重复。

最近更新时间：2025.12.26 18:32:40

这个页面对您有帮助吗？

有用

无用