帮你快速理解、总结文档立即下载
文档中心>腾讯云可观测平台

获取小程序告警屏蔽规则

最近更新时间：2026-08-26 01:54:45
我的收藏

本页目录：

1. 接口描述

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

获取小程序告警屏蔽规则

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeAlarmHistoryShield。
Version 是 String 公共参数，本接口取值：2018-07-24。
Region 否 String 公共参数，此参数为可选参数。
Module 是 String 模块名，这里填“monitor”
示例值：monitor
ShieldPolicyId 是 String 策略id
示例值：policy-xxx
ShieldObject.N 否 Array of String 告警历史维度
示例值：["{"appid":"1258344699","tke_cluster_instance_id":"cls-9d80vq6y","region":"ap-guangzhou"}"]
MetricName 否 String 指标名称
示例值：MetricName
ShieldId 否 String 屏蔽策略Id
示例值：Shield-xxxx
ShieldAlarmLevel 否 String 告警等级
示例值：["Warn"]
SessionId 否 String 告警历史会话ID
示例值：session-id
MonitorType 否 String 监控类型
示例值：MT_QCE

3. 输出参数

参数名称 类型 描述
ShieldId String 告警屏蔽规则的ID
示例值：Shield-xxxx
MonitorType String 监控类型
示例值：MT_QCE
Name String 屏蔽策略名称
示例值：测试屏蔽
Enable Integer 是否开启 1=开启 0=关闭
示例值：1
MonitorTypeShowName String 监控类型展示名称
示例值：云产品监控
NameSpace String 命名空间即策略类型
示例值：CKAFKA-CONSUMERGROUP-TOPIC
NameSpaceShowName String 策略类型展示名称
示例值：消息队列Kafka-ConsumerGroup-Topic
ShieldObject Array of String 屏蔽对象
注意：此字段可能返回 null，表示取不到有效值。
示例值：["cafka-xxx", "cafka-xxx"]
ShieldMetric Array of ShieldMetric 屏蔽指标列表
注意：此字段可能返回 null，表示取不到有效值。
ShieldTimeType String 屏蔽时间类型 FOREVER_SHIELD:永久屏蔽 PERIOD_SHIELD:绝对时间范围屏蔽 LOOP_SHIELD:相对时间范围屏蔽
示例值：LOOP_SHIELD
StartTime Integer 开始时间 10:00
注意：此字段可能返回 null，表示取不到有效值。
示例值：36000
EndTime Integer 结束时间 20:00
注意：此字段可能返回 null，表示取不到有效值。
示例值：72000
LoopStartDate Integer 循环开始日期 2022/04/01
注意：此字段可能返回 null，表示取不到有效值。
示例值：1648742400
LoopEndDate Integer 循环结束日期 2022/04/05
注意：此字段可能返回 null，表示取不到有效值。
示例值：1649088000
CurrentStatus String NOT_TRIGGERED:未生效 TRIGGERING:生效中 EXPIRED:已过期
示例值：NOT_TRIGGERED
ShieldPolicyId String 需要屏蔽的策略ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：12245
ShieldAlarmLevel Array of String 需要屏蔽的告警等级
注意：此字段可能返回 null，表示取不到有效值。
示例值：["Warn"]
ShieldTag String 屏蔽类型，1为维度屏蔽，0为实例名称屏蔽
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
MetricName String 指标名称
示例值：MetricName
TimeZone Float 时区
注意：此字段可能返回 null，表示取不到有效值。
示例值：8.5
SessionId String 告警历史会话ID
示例值：session-i
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 测试

测试

输入示例

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

{
    "Module": "monitor",
    "ShieldPolicyId": "2754411"
}

输出示例

{
    "Response": {
        "CurrentStatus": "EXPIRED",
        "Enable": 1,
        "EndTime": 1728577188,
        "LoopEndDate": 0,
        "LoopStartDate": 0,
        "MetricName": "cpu_usage",
        "MonitorType": "MT_QCE",
        "MonitorTypeShowName": "云产品监控",
        "Name": "",
        "NameSpace": "cvm_device",
        "NameSpaceShowName": "云服务器-基础监控",
        "RequestId": "3e08f0cc-7123-4274-8026-8e7fa147379a",
        "ShieldAlarmLevel": null,
        "ShieldId": "Shield-hbvoj4siyh",
        "ShieldMetric": null,
        "ShieldObject": [
            "{\"appid\":\"251000916\"",
            "\"projectid\":\"0\"",
            "\"vm_uuid\":\"b08d0134-3803-48ce-ba67-5cb38f0dd7d2\"}"
        ],
        "ShieldPolicyId": "2754411",
        "ShieldTag": "ALARMHISTORY",
        "ShieldTimeType": "PERIOD_SHIELD",
        "StartTime": 1728573588,
        "TimeZone": 8
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
中国站