修改告警屏蔽规则

最近更新时间: 2026-10-10 00:14:48

1. 接口描述

接口请求域名: cls.api3.fincloud.tencent.com。

修改告警屏蔽规则

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

接口更新时间:2025-03-28 15:38:56。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:ModifyAlarmShield
Version 是 否 String 公共参数,本接口取值:2020-10-16
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
TaskId 是 否 String 屏蔽规则ID。
示例值: 57f5808c-4a55-11eb-b378-0242ac130002
AlarmNoticeId 是 否 String 通知渠道组id。
示例值: notice-57f5808c-4a55-11eb-b378-0242ac130002
StartTime 否 否 Uint64 屏蔽开始时间(秒级时间戳)。
示例值: 1701872657
EndTime 否 否 Uint64 屏蔽结束时间(秒级时间戳)。
示例值: 1701883657
Type 否 否 Uint64 屏蔽类型。1:屏蔽所有通知,2:按照Rule参数屏蔽匹配规则的通知。
示例值: 2
Rule 否 否 String 屏蔽规则,当Type为2时必填。
示例值: {"Value":"AND","Type":"Operation","Children":[{"Type":"Condition","Value":"Level","Children":[{"Value":"In","Type":"Compare"},{"Value":"[1]","Type":"Value"}]},{"Type":"Condition","Value":"AlarmID","Children":[{"Value":"In","Type":"Compare"},{"Value":"["alarm-57f5808c-4a55-11eb-b378-0242ac130002"]","Type":"Value"}]}]}
Reason 否 否 String 屏蔽原因。
示例值: 屏蔽原因
Status 否 否 Uint64 规则状态。只有规则状态为生效中(status:1)时,才能将其修改为已失效(status:2)。
示例值: 2

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

5. 示例

示例1 修改告警屏蔽

修改告警屏蔽

输入示例

POST / HTTP/1.1
Host: cls.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: ModifyAlarmShield
<Common Parameters>

{
  "TaskId": "bb42f112-a74d-456e-b3c4-ff5472911b42",
  "AlarmNoticeId": "notice-bb42f112-a74d-456e-b3c4-ff5472911b42",
  "StartTime": 1701872657,
  "EndTime": 1701892657,
  "Type": 1,
  "Rule": "",
  "Reason": "reason"
}

输出示例

{
  "Response": {
    "RequestId": "1142f112-a74d-456e-b3c4-ff5472911b11"
  }
}