1. 接口描述
接口请求域名： monitor.tencentcloudapi.com 。
查询通知模板列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAlarmNotices。 |
| Version | 是 | String | 公共参数，本接口取值：2018-07-24。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Module | 是 | String | 模块名，这里填“monitor” 示例值：monitor |
| PageNumber | 是 | Integer | 页码 最小为1 示例值：1 |
| PageSize | 是 | Integer | 分页大小 1～200 示例值：20 |
| Order | 是 | String | 按更新时间排序方式 ASC=正序 DESC=倒序 示例值：DESC |
| OwnerUid | 否 | Integer | 主账号 uid 用于创建预设通知 示例值：1234567 |
| Name | 否 | String | 告警通知模板名称 用来模糊搜索 示例值：模板 |
| ReceiverType | 否 | String | 根据接收人过滤告警通知模板需要选定通知用户类型 USER=用户 GROUP=用户组 传空=不按接收人过滤 示例值：USER |
| UserIds.N | 否 | Array of Integer | 接收对象列表 示例值：[] |
| GroupIds.N | 否 | Array of Integer | 接收组列表 示例值：[] |
| NoticeIds.N | 否 | Array of String | 根据通知模板 id 过滤，空数组/不传则不过滤 示例值：["notice-ah28cv9d"] |
| Tags.N | 否 | Array of Tag | 模板根据标签过滤 |
| OnCallFormIDs.N | 否 | Array of String | 值班列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 告警通知模板总数 示例值：1 |
| Notices | Array of AlarmNotice | 告警通知模板列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询通知模板列表
查询通知模板列表
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmNotices
<公共请求参数>
{
"OwnerUid": 1234567,
"Module": "monitor",
"Name": "",
"ReceiverType": "",
"UserIds": [],
"GroupIds": [],
"PageNumber": 1,
"PageSize": 20,
"Order": "DESC",
"NoticeIds": [
"notice-ah28cv9d"
]
}输出示例
{
"Response": {
"TotalCount": 0,
"Notices": [
{
"Id": "abc",
"Name": "abc",
"UpdatedAt": "abc",
"UpdatedBy": "abc",
"NoticeType": "abc",
"UserNotices": [
{
"ReceiverType": "abc",
"UserIds": [
0
],
"GroupIds": [
0
],
"StartTime": 0,
"EndTime": 0,
"NoticeWay": [
"abc"
],
"PhoneOrder": [
0
],
"PhoneCircleTimes": 0,
"PhoneInnerInterval": 0,
"PhoneCircleInterval": 0,
"NeedPhoneArriveNotice": 0,
"PhoneCallType": "abc",
"Weekday": [
0
],
"OnCallFormIDs": [
"abc"
]
}
],
"URLNotices": [
{
"URL": "abc",
"IsValid": 0,
"ValidationCode": "abc",
"StartTime": 0,
"EndTime": 0,
"Weekday": [
0
]
}
],
"IsPreset": 0,
"NoticeLanguage": "abc",
"PolicyIds": [
"abc"
],
"AMPConsumerId": "abc",
"CLSNotices": [
{
"Enable": 0,
"Region": "abc",
"LogSetId": "abc",
"TopicId": "abc"
}
],
"Tags": [
{
"Key": "abc",
"Value": "abc"
}
]
}
],
"RequestId": "abc"
}
}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 | 操作不支持。 |
