文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心

创建告警屏蔽规则

最近更新时间：2026-07-06 02:35:41

我的收藏

本页目录：

1. 接口描述

接口请求域名： monitor.tencentcloudapi.com 。

创建告警屏蔽规则

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateAlarmShield。
Version 是 String 公共参数，本接口取值：2018-07-24。
Region 否 String 公共参数，此参数为可选参数。
Module 是 String

模块名，这里填“monitor”


示例值：monitor
Name 是 String

屏蔽策略名称


示例值：测试屏蔽
MonitorType 是 String

监控类型


示例值：MT_QCE
NameSpace 是 String

命名空间即策略类型


示例值：CKAFKA-CONSUMERGROUP-TOPIC
ShieldTimeType 是 String

屏蔽时间类型 FOREVER_SHIELD:永久屏蔽 PERIOD_SHIELD:绝对时间范围屏蔽 LOOP_SHIELD:相对时间范围屏蔽


示例值：LOOP_SHIELD
ShieldObject.N 否 Array of String

屏蔽对象


示例值：["cafka-xxx", "cafka-xxx"]
ShieldMetric.N 否 Array of String

屏蔽指标 为空则为全部指标


示例值：["UnconsumeTopic", "MaxOffsetTopic"]
StartTime 否 Integer

开始时间 相对时间范围:36000 绝对时间范围:1648742400 缺省:0


示例值：36000
EndTime 否 Integer

结束时间 相对时间范围:72000 绝对时间范围:1649088000 缺省:0


示例值：72000
LoopStartDate 否 Integer

循环开始日期 2022/04/01 缺省:0


示例值：1648742400
LoopEndDate 否 Integer

循环结束日期 2022/04/05 缺省:0


示例值：1649088000
ShieldPolicyId 否 String

需要屏蔽的策略ID


示例值：policy-1111
ShieldAlarmLevel.N 否 Array of String

需要屏蔽的告警等级，取值范围Warn,Remind,Serious


示例值：["Warn"]
VersionTag 否 String

屏蔽类型，为OBJNAME是实例屏蔽，为POLICY是策略屏蔽


示例值：OBJNAME
Description 否 String

屏蔽规则的描述


示例值：实例下线，告警策略不再需要
TimeZone 否 Float

时区，东八区+8，西八区减8，以此类推


示例值：5.5
ShieldEvent.N 否 Array of String

屏蔽事件 为空则为全部指标


示例值：["cpm:ErrorEvent:SsdTempe"]
ShieldMetricFlag 否 Integer

是否对指标屏蔽 1=是 0=否


示例值：1
ShieldEventFlag 否 Integer

是否对事件屏蔽 1=是 0=否


示例值：1

3. 输出参数

参数名称 类型 描述
ShieldId String

屏蔽规则的Id


示例值：Shield-xxxx
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 CreateAlarmShield示例1

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlarmShield
<公共请求参数>

{
    "LoopStartDate": "1648742400",
    "StartTime": "36000",
    "NameSpace": "cvm_device",
    "Module": "monitor",
    "ShieldMetric": [
        "CpuUsage"
    ],
    "LoopEndDate": "1649088000",
    "ShieldTimeType": "LOOP_SHIELD",
    "MonitorType": "MT_QCE",
    "EndTime": "72000",
    "ShieldObject": [
        "cafka-xxx"
    ],
    "Name": "1311"
}

输出示例

{
    "Response": {
        "RequestId": "f4f51ecc-c3fa-4e0a-a9b5-093b1a58013e",
        "ShieldId": "Shield-wixc9u804z"
    }
}

示例2 创建告警屏蔽规则

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlarmShield
<公共请求参数>

{
    "Module": "monitor",
    "Name": "测试屏蔽",
    "MonitorType": "MT_QCE",
    "NameSpace": "cvm_device",
    "ShieldObject": [
        "cafka-xxx",
        "cafka-xxx1"
    ],
    "ShieldMetric": [
        "CpuUsage",
        "BaseCpuUsage"
    ],
    "ShieldTimeType": "LOOP_SHIELD",
    "StartTime": "36000",
    "EndTime": "72000",
    "LoopStartDate": "1648742400",
    "LoopEndDate": "1649088000"
}

输出示例

{
    "Response": {
        "RequestId": "29ghj2hh-45-266627r66hheh-23",
        "ShieldId": "shield-xxxx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。
中国站