UpdateSilencePolicy--云监控-火山引擎

文档中心

立即注册

导航

UpdateSilencePolicy

最近更新时间：2025.05.16 17:56:37首次发布时间：2025.05.16 17:56:37

更新屏蔽策略。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdateSilencePolicy&Version=2018-01-01

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateSilencePolicy	接口名称。当前 API 的名称为 `UpdateSilencePolicy`。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 `2018-01-01`。
Name	String	是	silence-policy	屏蔽策略名称。不能以数字、中划线`-`开头。长度限制在 1～128 字符之间。
Id	String	是	19222306***	屏蔽策略 ID。可以通过 ListSilencePolicy 接口，获取屏蔽策略 ID。
Description	String	否	this is a silence policy	屏蔽策略的描述信息。不能以数字、中划线`-`、中文符号开头。只能包含中文，英文字母，数字，下划线`_`，中划线`-`、中文符号。长度限制在 0～255 字符之间。
Namespace	String	是	VCM_ECS	该策略监控指标所属的产品空间。详情请参见云产品监控指标下各产品的 Namespace。
SilenceType	String	是	metric	屏蔽策略类型，取值： metric：告警屏蔽策略。 event：事件屏蔽策略。
SilenceConditions	Object of SilenceConditions	否	-	屏蔽条件。
EffectTime	Object of EffectTime	是	-	屏蔽策略的生效时间段。

SilenceConditions

参数	类型	是否必选	示例值	描述
RuleId	String	否	1894363***	告警策略 ID 或事件规则 ID，未配置`MetaCondition`时表示屏蔽所有资源。
EventType	Array of String	否	["ecs:Disk:DiskError.Redeploy.Executing"]	屏蔽策略匹配的事件类型。仅`SilenceType`为`event`时有效。最多支持配置 100 条。
MetaCondition	Object of SilenceCondition	否	-	屏蔽资源筛选。

EffectTime

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Type	String	是	always	屏蔽策略生效时间类型，取值： always：永久屏蔽。 once：绝对时间屏蔽，一次生效。 daily：相对时间屏蔽，循环生效。
Range	Array of Range	否	-	屏蔽策略生效的时间范围。仅当`Type`为`once`或`daily`时，需要配置。说明最多支持添加 3 个时间范围。

Type

String

是

always

屏蔽策略生效时间类型，取值：

always：永久屏蔽。
once：绝对时间屏蔽，一次生效。
daily：相对时间屏蔽，循环生效。

Range

Array of Range

否

屏蔽策略生效的时间范围。仅当Type为once或daily时，需要配置。

说明

最多支持添加 3 个时间范围。

SilenceCondition

参数	类型	是否必选	示例值	描述
Metas	Array of SilenceKVComparator	否	-	屏蔽条件。说明最多允许配置 10 个屏蔽条件。
Condition	String	否	and	屏蔽条件逻辑，取值： and：全部满足。 or：任意满足。

参数

类型

是否必选

示例值

描述

Metas

Array of SilenceKVComparator

否

屏蔽条件。

说明

最多允许配置 10 个屏蔽条件。

Condition

String

否

and

屏蔽条件逻辑，取值：

and：全部满足。
or：任意满足。

Range

参数	类型	是否必选	示例值	描述
StartDate	String	否	2025-03-10	屏蔽策略生效的开始日期。当`Type`为`once`时，为必选配置。当`Type`为`daily`时，为可选配置。配置该参数时，表示在指定日期内循环生效。未配置该参数时，表示永久循环生效。说明 `StartDate`和`EndDate`必须同时配置，且`StartDate`必须要早于`EndDate`。
EndDate	String	否	2025-03-11	屏蔽策略生效的结束日期。当`Type`为`once`时，为必选配置。当`Type`为`daily`时，为可选配置。配置该参数时，表示在指定日期内循环生效。未配置该参数时，表示永久循环生效。说明 `StartDate`和`EndDate`必须同时配置，且`StartDate`必须要早于`EndDate`。
StartTime	String	否	08:00	屏蔽策略生效的开始时间。当`Type`为`once`时，为带日期的绝对时间，例如：`2006-01-02 15:04`。当`Type`为`daily`时，为每天的生效时间，例如`08:00`。说明 `StartTime`和`EndTime`必须同时配置，且`StartTime`必须要早于`EndTime`。
EndTime	String	否	16:00	屏蔽策略生效的结束时间。当`Type`为`once`时，为带日期的绝对时间，例如：`2006-01-02 18:00`。当`Type`为`daily`时，为每天的生效时间，例如`16:00`。说明 `StartTime`和`EndTime`必须同时配置，且`StartTime`必须要早于`EndTime`。

SilenceKVComparator

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Key	String	否	ResourceID	配置告警屏蔽策略时，支持配置为 DimensionName，例如：如果`Namespace`为`VCM_VKE`，则可填写`Cluster`，`Node`等。配置事件屏蔽策略时：支持配置为`ResourceID`，表示按照资源进行屏蔽。支持配置为`data.xxx`，表示按照事件详情中的值进行屏蔽。
Values	Array of String	否	["i-ydvsmy***"]	`Key`对应的值。数组个数限制最大 100 个，每个值最多可为 128 个字符。
Comparator	String	否	equal	标签匹配时的比较符。 contain：包含 not_contain：不包含 prefix_match：前缀匹配 suffix_match：后缀匹配 equal：等于 not_equal：不等于

Key

String

否

ResourceID

配置告警屏蔽策略时，支持配置为 DimensionName，例如：如果Namespace为VCM_VKE，则可填写Cluster，Node等。
配置事件屏蔽策略时：
- 支持配置为ResourceID，表示按照资源进行屏蔽。
- 支持配置为data.xxx，表示按照事件详情中的值进行屏蔽。

Values

Array of String

否

["i-ydvsmy***"]

Key对应的值。
数组个数限制最大 100 个，每个值最多可为 128 个字符。

Comparator

String

否

equal

标签匹配时的比较符。

contain：包含
not_contain：不包含
prefix_match：前缀匹配
suffix_match：后缀匹配
equal：等于
not_equal：不等于

请求示例

POST https://open.volcengineapi.com?Action=UpdateSilencePolicy&Version=2018-01-01
Content-Type: application/json
{
    "Name": "silence-policy",
    "Id": "19222306***",
    "Namespace": "VCM_ECS",
    "Description": "this is a silence policy",
    "SilenceType": "event",
    "EffectTime": {
        "Type": "daily",
        "Range": [
            {
                "EndDate": "2025-03-11",
                "EndTime": "16:00",
                "StartDate": "2025-03-10",
                "StartTime": "08:00"
            }
        ]
    },
    "SilenceConditions": {
        "RuleId": "1856943902796222464",
        "EventType": [
            "ecs:Instance:RebootInstance.Executing"
        ],
        "MetaCondition": {
            "Metas": [
                {
                    "Key": "ResourceID",
                    "Values": [
                        "i-ydvsmy***"
                    ],
                    "Comparator": "equal"
                }
            ],
            "Condition": "and"
        }
    }
}

返回参数

参数	类型	示例值	描述
Data	Array of String	19222306***	屏蔽策略 ID。

返回示例

{
    "ResponseMetadata": {
        "Action": "UpdateSilencePolicy",
        "Region": "cn-beijing",
        "Service": "Volc_Observe",
        "Version": "2018-01-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Data": [
            "19222306***"
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请参见错误码。