创建告警通知模板

最近更新时间: 2026-09-17 00:06:36

1. 接口描述

接口请求域名： cls.api3.fincloud.tencent.cn。

该接口用户创建告警通知模板。

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

接口更新时间：2025-08-14 09:48:12。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：CreateAlarmNotice
Version 是 否 String 公共参数，本接口取值：2020-10-16
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Name 是 否 String 通知渠道组名称。
示例值： notice_name
Type 否 否 String 【简易模式】（简易模式/告警模式二选一，分别配置相应参数） 需要发送通知的告警类型。可选值：  Trigger - 告警触发 Recovery - 告警恢复 All - 告警触发和告警恢复
示例值： All
NoticeReceivers 否 否 Array of NoticeReceiver 【简易模式】（简易模式/告警模式二选一，分别配置相应参数） 通知接收对象。
示例值：查看
WebCallbacks 否 否 Array of WebCallback 【简易模式】（简易模式/告警模式二选一，分别配置相应参数） 接口回调信息（包括企业微信、钉钉、飞书）。
示例值：查看
Tags 否 否 Array of Tag 标签描述列表，通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持50个标签键值对，并且不能有重复的键值对。
示例值：查看
JumpDomain 否 否 String 查询数据链接。http:// 或者 https:// 开头，不能/结尾
示例值： https://console.demo.com
NoticeRules 否 否 Array of NoticeRule 【高级模式】（简易模式/告警模式二选一，分别配置相应参数） 通知规则。
示例值：查看

3. 输出参数

参数名称 类型 描述
AlarmNoticeId String 告警模板ID
示例值： notice-f0454407-1bb2-48c7-b224-653d4b236d14
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 创建告警通知模板

输入示例

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

{
    "Name": "test",
    "Type": "All",
    "WebCallbacks" : [{
         "CallbackType": "Http", 
         "Url":"http://www.testnotice.com/callback",
         "Method": "POST",
         "Headers": ["Content-Type:appliction/json"],
         "Body": "{\"Uin\":\"${UIN}\",\"AlarmId\":\"alarm-dfa4ac24-caa1-4e30-a027-349cb29937c4\"}"
     }]
}

输出示例

{
    "Response": {
        "AlarmNoticeId": "dfa4ac24-caa1-4e30-a027-349cb29937c4",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}