日志服务创建通知渠道组-告警策略相关接口-API 中心-腾讯云

1. 接口描述

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

该接口用于创建通知渠道组，提供两种配置模式，二选一：
1，简易模式，提供最基本的通知渠道功能。需填写如下参数：

Type
NoticeReceivers
WebCallbacks

2，高级模式，在简易模式基础上，支持设定规则，为不同类型的告警分别设定通知渠道，并支持告警升级功能。需填写如下参数：

NoticeRules

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateAlarmNotice。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
Name	是	String	通知渠道组名称。示例值：test
Tags.N	否	Array of Tag	标签描述列表，通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持50个标签键值对，并且不能有重复的键值对。
Type	否	String	【简易模式】（简易模式/告警模式二选一，分别配置相应参数）需要发送通知的告警类型。可选值： - Trigger - 告警触发 - Recovery - 告警恢复 - All - 告警触发和告警恢复示例值：All
NoticeReceivers.N	否	Array of NoticeReceiver	【简易模式】（简易模式/告警模式二选一，分别配置相应参数）通知接收对象。
WebCallbacks.N	否	Array of WebCallback	【简易模式】（简易模式/告警模式二选一，分别配置相应参数）接口回调信息（包括企业微信、钉钉、飞书）。
NoticeRules.N	否	Array of NoticeRule	【高级模式】（简易模式/告警模式二选一，分别配置相应参数）通知规则。
JumpDomain	否	String	查询数据链接。http:// 或者 https:// 开头，不能/结尾示例值：https://console.cloud.tencent.com
DeliverStatus	否	Integer	投递日志开关。可取值如下： 1：关闭（默认值）； 2：开启投递日志开关开启时， DeliverConfig参数必填。示例值：2
DeliverConfig	否	DeliverConfig	投递日志配置参数。当DeliverStatus开启时，必填。
AlarmShieldStatus	否	Integer	免登录操作告警开关。可取值如下： - 1：关闭 - 2：开启（默认值）示例值：1

3. 输出参数

参数名称	类型	描述
AlarmNoticeId	String	告警模板ID 示例值：notice-f0454407-1bb2-48c7-b224-653d4b236d14
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建通知渠道组（简易模式）

包含两个通知渠道：

使用短信（sms）、电话（phone）通知用户组（Group），用户组id为27411
发送通知至企业微信（WeCom）机器人

输入示例

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

{
    "Name": "demoAlarmNotice1",
    "Type": "All",
    "NoticeReceivers": [
        {
            "ReceiverType": "Group",
            "ReceiverIds": [
                27411
            ],
            "ReceiverChannels": [
                "Sms",
                "Phone"
            ],
            "StartTime": "00:00:00",
            "EndTime": "23:59:59",
            "NoticeContentId": "Default-zh",
            "Index": 1
        }
    ],
    "WebCallbacks": [
        {
            "Method": "POST",
            "CallbackType": "WeCom",
            "NoticeContentId": "Default-zh",
            "Url": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxx-xxxx-xxxx-xxxx-xxxx"
        }
    ],
    "NoticeRules": [],
    "DeliverStatus": 1,
    "AlarmShieldStatus": 2
}

输出示例

{
    "Response": {
        "AlarmNoticeId": "xxxx-xx-xx-xx-xxxxxxxx",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

示例2 创建通知渠道组（高级模式）

包含两个环节，告警先通知环节1，10分钟后如果告警无人认领且未恢复时通知环节2.
环节1包含2个通知渠道：

使用短信（sms）、电话（phone）通知用户组（Group），用户组id为27411
发送通知至企业微信（WeCom）机器人
环节2包含1个通知渠道
使用短信（sms）、电话（phone）通知用户组（Uin），用户id为6318337

输入示例

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

{
    "Name": "demoAlarmNotice2",
    "NoticeRules": [
        {
            "NoticeReceivers": [
                {
                    "ReceiverType": "Group",
                    "ReceiverIds": [
                        27411
                    ],
                    "ReceiverChannels": [
                        "Sms",
                        "Phone"
                    ],
                    "StartTime": "00:00:00",
                    "EndTime": "23:59:59",
                    "NoticeContentId": "Default-zh"
                }
            ],
            "WebCallbacks": [
                {
                    "Method": "POST",
                    "CallbackType": "WeCom",
                    "NoticeContentId": "Default-zh",
                    "Url": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxx-xxxx-xxxx-xxxx-xxxx"
                }
            ],
            "Escalate": true,
            "Type": 1,
            "Interval": 10,
            "EscalateNotice": {
                "NoticeReceivers": [
                    {
                        "ReceiverType": "Uin",
                        "ReceiverIds": [
                            6318337
                        ],
                        "ReceiverChannels": [
                            "Sms",
                            "Phone"
                        ],
                        "StartTime": "00:00:00",
                        "EndTime": "23:59:59",
                        "NoticeContentId": "Default-zh"
                    }
                ],
                "WebCallbacks": [],
                "Escalate": false
            },
            "Rule": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1,2]\",\"Type\":\"Value\"}]}]}"
        }
    ],
    "DeliverStatus": 1,
    "AlarmShieldStatus": 2
}

输出示例

{
    "Response": {
        "AlarmNoticeId": "xxxx-xx-xx-xx-xxxxxxxx",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

创建通知渠道组

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 创建通知渠道组（简易模式）

输入示例

输出示例

示例2 创建通知渠道组（高级模式）

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码