修改告警屏蔽规则

最近更新时间:2024-03-12 01:18:12

我的收藏

1. 接口描述

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

该接口用于修改告警屏蔽规则。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyAlarmShield。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
TaskId String 屏蔽规则ID。
示例值:cb37f589-6232-431a-xxxx-e2b61fb375d1
AlarmNoticeId String 通知渠道组id。
示例值:notice-bb42f112-xxxx-456e-b3c4-ff5472911b42
StartTime Integer 屏蔽开始时间(秒级时间戳)。
示例值:1701872657
EndTime Integer 屏蔽结束时间(秒级时间戳)。
示例值:1701883657
Type Integer 屏蔽类型。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-57105ec6-xxxx-xxxx-xxxx-892f3b8d143a"]","Type":"Value"}]}]}
Reason String 屏蔽原因。
示例值:屏蔽原因
Status Integer 规则状态。只有规则状态为生效中(status:1)时,才能将其修改为已失效(status:2)。

3. 输出参数

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

4. 示例

示例1 修改告警屏蔽

修改告警屏蔽

输入示例

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

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.Timeout 操作超时
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.AlarmNoticeConflict 告警策略通知模板已经存在。
MissingParameter 缺少参数错误。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。