创建告警渠道回调配置

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

1. 接口描述

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

创建告警渠道回调配置

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

接口更新时间：2026-01-20 16:42:36。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：CreateWebCallback
Version	是	否	String	公共参数，本接口取值：2020-10-16
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Name	是	否	String	通知内容名称。示例值： alarm_name
Type	是	否	String	渠道类型。 WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调。示例值： WeCom
Webhook	是	否	String	Webhook地址。示例值： http://cls.api3.fincloud.tencent.com/send
Method	否	否	String	请求方式。支持POST、PUT。当Type为Http时，必填。示例值： POST
Key	否	否	String	秘钥。示例值： AASFFGGYYBHGTDJ

3. 输出参数

参数名称	类型	描述
WebCallbackId	String	回调配置ID。示例值： webcallback-57f5808c-4a55-11eb-b378-0242ac130002
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 创建告警渠道回调配置

创建告警渠道回调配置

输入示例

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

{
  "Name": "alarm_name",
  "Type": "WeCom",
  "Webhook": "http://cls.api3.fincloud.tencent.com/send",
  "Method": "POST",
  "Key": "AADSHFYFNJKGYENGKVYDNGKFH<"
}

输出示例

{
  "Response": {
    "WebCallbackId": "webcallback-aaa-bbb-ccc-ddd",
    "RequestId": "demo-demo-demo-demo"
  }
}