获取告警通知模板列表

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

1. 接口描述

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

该接口用于获取告警通知模板列表

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

接口更新时间：2025-07-22 19:33:59。

接口只验签名不鉴权。

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeAlarmNotices
Version	是	否	String	公共参数，本接口取值：2020-10-16
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Filters	否	否	Array of Filter	name 按照【通知渠道组名称】进行过滤。类型：String 必选：否 alarmNoticeId 按照【通知渠道组ID】进行过滤。类型：String 必选：否 uid 按照【接收用户ID】进行过滤。类型：String 必选：否 groupId 按照【接收用户组ID】进行过滤。类型：String 必选：否 deliverFlag 按照【投递状态】进行过滤。类型：String 必选：否可选值： "1":未启用, "2": 已启用, "3":投递异常每次请求的Filters的上限为10，Filter.Values的上限为5。示例值：查看
Offset	否	否	Int64	分页的偏移量，默认值为0。示例值： 1
Limit	否	否	Int64	分页单页限制数目，默认值为20，最大值100。示例值： 1

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

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

错误码	描述
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
InternalError	内部错误。
OperationDenied	操作被拒绝。
OperationDenied.ACLFailed	ACL校验失败。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountNotExists	账户不存在。

示例1 获取告警通知模板列表

输入示例

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

{}

输出示例

{
    "Response":{
        "TotalCount": 0,
        "AlarmNotices":[
         ],
        "RequestId":"6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}