查询通知模板列表

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

1. 接口描述

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

查询通知模板列表

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

接口更新时间：2022-11-22 16:04:12。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeAlarmNotices
Version	是	否	String	公共参数，本接口取值：2018-07-24
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Module	是	否	String	模块名，这里填“monitor” 示例值： monitor
OwnerUid	否	否	Int64	主账号 uid 用于创建预设通知示例值： 1234567
Name	否	否	String	告警通知模板名称用来模糊搜索示例值：模板
ReceiverType	否	否	String	根据接收人过滤告警通知模板需要选定通知用户类型 USER=用户 GROUP=用户组传空=不按接收人过滤示例值： USER
UserIds	否	否	Array of Int64	接收对象列表示例值： [1234567]
GroupIds	否	否	Array of Int64	接收组列表示例值： [1234567]
PageNumber	是	否	Int64	页码最小为1 示例值： 1
PageSize	是	否	Int64	分页大小 1～200 示例值： 20
Order	是	否	String	按更新时间排序方式 ASC=正序 DESC=倒序示例值： DESC
AMPConsumerIds	否	否	Array of String	根据后台 amp consumer id 列表过滤，传空不过滤示例值： ["Consumer-9gfn2g92hg92"]
NoticeIds	否	否	Array of String	根据通知模板 id 过滤，空数组/不传则不过滤示例值： ["notice-ah28cv9d"]

3. 输出参数

参数名称	类型	描述
TotalCount	Int64	告警通知模板总数示例值： 1
Notices	Array of AlarmNotice	告警通知模板列表示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
ResourceNotFound	资源不存在。
FailedOperation	操作失败。
UnsupportedOperation	操作不支持。
AuthFailure.UnauthorizedOperation	请求未授权。请参考 CAM 文档对鉴权的说明。
InvalidParameterValue	无效的参数值。

5. 示例

示例1 查询通知模板列表

输入示例

POST / HTTP/1.1
Host: monitor.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeAlarmNotices
<公共请求参数>

{
    "Action": "DescribeAlarmNotices",
    "OwnerUid":1234567,
    "Name": "",
    "ReceiverType": "",
    "UserIds": [],
    "GroupIds": [],
    "PageNumber": 1,
    "PageSize": 20,
    "Order": "DESC"
}
https://monitor.api3.fincloud.tencent.cn/?Action=DescribeAllNamespaces&Module="monitor"&OwnerUid="1598976507"&Name="1598976507"&ReceiverType="1000000"&UserIds="monitor"&GroupIds="1598976507"&PageNumber="1598976507"&PageSize="1598976507"&Order="1598976507"
&<公共请求参数>

输出示例

{
    "Response":{
        "Notices":[
            {
                "Id":"notice-lc0bjcrq",
                "Name":"系统预设通知模板",
                "UpdatedAt":"2020-10-15 22:42:32",
                "UpdatedBy":"789789789",
                "NoticeType":"ALL",
                "UserNotices":[
                    {
                        "ReceiverType":"USER",
                        "UserIds":[
                            1234567
                        ],
                        "GroupIds":null,
                        "StartTime":0,
                        "EndTime":86399,
                        "NoticeWay":[
                            "SMS",
                            "EMAIL"
                        ],
                        "PhoneOrder":null,
                        "PhoneCircleTimes":0,
                        "PhoneInnerInterval":0,
                        "PhoneCircleInterval":0,
                        "NeedPhoneArriveNotice":0
                    }
                ],
                "URLNotices":[

                ],
                "IsPreset":1,
                "NoticeLanguage": "zh-CN",
                "PolicyIds": []
            }
        ],
        "RequestId":"mcy414ov4yom5l9lcam6phul347qqv41",
        "TotalCount":1
    }
}