You need to enable JavaScript to run this app.
导航
云监控
  • 文档首页
    • /云监控/API 参考/屏蔽策略/ListSilencePolicy
ListSilencePolicy
最近更新时间：2025.05.16 17:56:37首次发布时间：2025.05.16 17:56:37
我的收藏
有用
有用
无用
无用

查询屏蔽策略。

请求说明

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

调试

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

请求参数

参数类型是否必选示例值描述
ActionString是ListSilencePolicy接口名称。当前 API 的名称为 ListSilencePolicy。
VersionString是2018-01-01接口版本。当前 API 的版本为 2018-01-01。

Name

String

否

silence-policy

根据屏蔽策略名称筛选，模糊匹配。

  • 不能以数字、中划线-开头。
  • 长度限制在 1～128 字符之间。
IdsArray of String否19222306***根据屏蔽策略 ID 筛选。
NamespacesArray of String否["VCM_ECS","VCM_VKE"]根据云产品名称筛选，支持配置多个值，多个值之间用半角逗号,间隔。例如["VCM_ECS","VCM_VKE"]。

EnableState

Array of String

否

enable

根据屏蔽策略状态筛选，取值：

  • enable：启用
  • disable：禁用

SilenceType

Array of String

否

metric

根据屏蔽策略类型筛选，取值：

  • metric：告警屏蔽策略。
  • event：事件屏蔽策略。

ValidState

String

否

active

根据屏蔽策略是否有效筛选，取值：

  • active：有效
  • expired：已到期

PageNumber

Integer

否

1

分页查询参数，用于设置当前页码。默认值：1。

  • 实际起始位置 = (PageNumber-1) * PageSize
  • 实际终止位置 = PageNumber * PageSize
PageSizeInteger否30分页查询参数，用于设置每页行数。默认值：30。

请求示例

POST https://open.volcengineapi.com?Action=ListSilencePolicy&Version=2018-01-01
Content-Type: application/json
{
    "Name": "silence-policy",
    "Ids": [
        "19222306***"
    ],
    "Namespaces": [
        "VCM_ECS",
        "VCM_VKE"
    ],
    "EnableState": [
        "enable"
    ],
    "SilenceType": [
        "event"
    ],
    "ValidState": "active",
    "PageNumber": 1,
    "PageSize": 30
}

返回参数

参数类型示例值描述
DataArray of SilencePolicy-屏蔽策略详情。

SilencePolicy

参数类型示例值描述
IdString19222306***屏蔽策略 ID。
NameStringsilence-policy屏蔽策略名称。
DescriptionStringthis is a silence policy屏蔽策略描述信息。
CreatedAtString1659421463屏蔽策略创建时间。时间戳格式。
NamespaceStringVCM_ECS屏蔽策略监控指标所属的产品空间。详情请参见 云产品监控指标 下各产品的 Namespace。
UpdatedAtString1659529768屏蔽策略最后更新时间。时间戳格式。
EffectTimeObject of EffectTime-屏蔽策略生效时间段。
ValidStateStringenable屏蔽策略是否失效。当返回值为expired时表示失效。

EnableState

String

enable

屏蔽策略状态，取值：

  • enable：启用
  • disable：禁用

SilenceType

String

metric

屏蔽策略类型，取值：

  • metric：告警屏蔽策略。
  • event：事件屏蔽策略。
SilenceConditionsObject of SilenceConditions-屏蔽条件。

EffectTime

参数类型示例值描述

Type

String

always

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

  • always：永久屏蔽。
  • once：绝对时间屏蔽。
  • daily：相对时间屏蔽，每天循环。
RangeArray of Range-时间范围。

SilenceConditions

参数类型示例值描述
RuleIdString1894363***告警策略 ID 或事件规则 ID，未配置MetaCondition时表示屏蔽所有资源。

EventType

Array of String

["ecs:Disk:DiskError.Redeploy.Executing"]

屏蔽策略匹配的事件类型。
仅SilenceType为event时有效。最多支持配置 100 条。

MetaConditionObject of SilenceCondition-屏蔽资源筛选。

Range

参数类型示例值描述

StartDate

String

2024-10-01

屏蔽策略生效的开始日期。

  • 当Type为once时，为必选配置。
  • 当Type为daily时，为可选配置。
    • 配置该参数时，表示在指定日期内循环生效。
    • 未配置该参数时，表示永久循环生效。

说明

StartDate和EndDate必须同时配置，且StartDate必须要早于EndDate。

EndDate

String

2024-10-30

屏蔽策略生效的结束日期。

  • 当Type为once时，为必选配置。
  • 当Type为daily时，为可选配置。
    • 配置该参数时，表示在指定日期内循环生效。
    • 未配置该参数时，表示永久循环生效。

说明

StartDate和EndDate必须同时配置，且StartDate必须要早于EndDate。

StartTime

String

08:00

屏蔽策略生效的开始时间。

  • 当Type为once时，为带日期的绝对时间，例如：2006-01-02 15:04。
  • 当Type为daily时，为每天的时间，例如08:00。

EndTime

String

16:00

屏蔽策略生效的结束时间。

  • 当Type为once时，为带日期的绝对时间，例如：2006-01-02 18:00。
  • 当Type为daily时，为每天的时间，例如16:00。

SilenceCondition

参数类型示例值描述

Metas

Array of SilenceKVComparator

-

屏蔽条件。

说明

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

Condition

String

and

屏蔽条件逻辑，取值：

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

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：不等于

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202503101953411F3BBDBD6E90438E2B95",
        "Action": "ListSilencePolicy",
        "Version": "2018-01-01",
        "Service": "volc_observe",
        "Region": "cn-beijing"
    },
    "Result": {
        "Data": [
            {
                "Name": "silence-policy",
                "Id": "1873407632939147264",
                "CreatedAt": "1735490161",
                "UpdatedAt": "1735827170",
                "Description": "",
                "Namespace": "VCM_ECS",
                "EnableState": "disable",
                "ValidState": "active",
                "EffectTime": {
                    "Type": "always"
                },
                "SilenceType": "metric",
                "SilenceConditions": {
                    "MetaCondition": {
                        "Condition": "or",
                        "Metas": [
                            {
                                "Key": "ResourceID",
                                "Values": [
                                    "i-ydlzxal***"
                                ],
                                "Comparator": "equal"
                            },
                            {
                                "Key": "ResourceID",
                                "Values": [
                                    "18265077***"
                                ],
                                "Comparator": "not_contain"
                            }
                        ]
                    }
                }
            }
        ],
        "PageNumber": 2,
        "PageSize": 10,
        "TotalCount": 52
    }
}

错误码

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