创建告警渠道回调配置

最近更新时间:2025-01-03 01:13:06

我的收藏

1. 接口描述

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

该接口用于创建告警渠道回调配置。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateWebCallback。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,本接口不需要传递此参数。
Name String 通知内容名称。
示例值:监控告警专用
Type String 渠道类型。

WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调。
示例值:WeCom
Webhook String Webhook地址。
示例值:http://xxxx.com/send
Method String 请求方式。 支持POST、PUT。

当Type为Http时,必填。
示例值:POST
Key String 秘钥。
示例值:AASFFGGYYBHGTDJ

3. 输出参数

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

4. 示例

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

创建告警渠道回调配置

输入示例

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

{
    "Name": "监控告警专用",
    "Type": "WeCom",
    "Webhook": "http://www.xxx.com/send",
    "Method": "POST",
    "Key": "AADSHFYFNJKGYENGKVYDNGKFH<"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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