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

修改小程序告警屏蔽规则

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

1. 接口描述

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

修改小程序告警屏蔽规则

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyAlarmHistoryShield。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,此参数为可选参数。
Module String 模块名,这里填“monitor”
示例值:monitor
ShieldId String 屏蔽策略的Id
示例值:Shield-xxxx
Name String 屏蔽策略名称
示例值:测试屏蔽
MonitorType String 监控类型
示例值:MT_QCE
ShieldTimeType String 屏蔽时间类型 FOREVER_SHIELD:永久屏蔽 PERIOD_SHIELD:绝对时间范围屏蔽 LOOP_SHIELD:相对时间范围屏蔽
示例值:LOOP_SHIELD
ShieldPolicyId String 需要屏蔽的策略ID
示例值:policy-xxx
NameSpace String 命名空间即策略类型
示例值:CKAFKA-CONSUMERGROUP-TOPIC
ShieldObject.N Array of String 屏蔽对象
示例值:["cafka-xxx", "cafka-xxx"]
MetricName String 指标名称
示例值:CpuUsage
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
ShieldAlarmLevel String 需要屏蔽的告警等级
示例值:WARN
TimeZone Float 时区,东八区+8,西八区减8,以此类推
示例值:8.5
SessionId String 告警历史会话ID
示例值:sessionxxx

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 测试

测试

输入示例

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

{
    "Module": "xyz",
    "Name": "exampleName",
    "MonitorType": "exampleMonitorType",
    "NameSpace": "exampleNamespace",
    "ShieldObject": [
        "exampleObject"
    ],
    "ShieldPolicyId": "examplePolicyId",
    "ShieldId": "shield-xxx",
    "ShieldTimeType": "exampleTimeType",
    "StartTime": 1620000000,
    "EndTime": 1620003600,
    "LoopStartDate": 1620000000,
    "LoopEndDate": 1620003600,
    "ShieldAlarmLevel": "high",
    "TimeZone": 8,
    "MetricName": "exampleMetricName"
}

输出示例

{
    "Response": {
        "RequestId": "55591ca4-f797-43ac-b1af-3b09ca24091f"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码