1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
创建通知模板
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAlarmNotice。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Module | 是 | String | 模块名,这里填“monitor” 示例值:monitor |
Name | 是 | String | 通知模板名称 60字符以内 示例值:默认通知模板 |
NoticeType | 是 | String | 通知类型 ALARM=未恢复通知 OK=已恢复通知 ALL=都通知 示例值:ALL |
NoticeLanguage | 是 | String | 通知语言 zh-CN=中文 en-US=英文 示例值:zh-CN |
UserNotices.N | 否 | Array of UserNotice | 用户通知 最多5个 |
URLNotices.N | 否 | Array of URLNotice | 回调通知 最多6个 |
CLSNotices.N | 否 | Array of CLSNotice | 推送CLS日志服务的操作 最多1个 |
Tags.N | 否 | Array of Tag | 模板绑定的标签 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NoticeId | String | 告警通知模板ID 示例值:notice-abcdef |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建通知模板
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlarmNotice
<公共请求参数>
{
"Module": "monitor",
"Name": "noticeA",
"NoticeType": "ALL",
"NoticeLanguage": "zh-CN",
"UserNotices": [
{
"ReceiverType": "USER",
"UserIds": [
10001
],
"NoticeWay": [
"SMS",
"EMAIL"
],
"StartTime": 0,
"EndTime": 1,
"PhoneOrder": [
10001
],
"PhoneCircleInterval": 60,
"PhoneCircleTimes": 2,
"PhoneInnerInterval": 60,
"NeedPhoneArriveNotice": 1,
"PhoneCallType": "CIRCLE"
}
],
"URLNotices": [
{
"URL": "https://www.mytest.com/validate"
}
]
}
输出示例
{
"Response": {
"NoticeId": "notice-2h92ghf2",
"RequestId": "neh390an4opw0-45nw"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
FailedOperation.DoHTTPTransferFailed | 后端服务超时 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |