获取通知内容模板

1. 接口描述

接口请求域名： monitor.tencentcloudapi.com 。

根据查询条件获取自定义通知内容模板，若所有查询条件空，则获取账号下所有模板

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeNoticeContentTmpl。
Version	是	String	公共参数，本接口取值：2023-06-16。
Region	否	String	公共参数，此参数为可选参数。
PageNumber	是	Integer	分页数示例值：1
PageSize	是	Integer	分页大小示例值：10
TmplIDs.N	否	Array of String	指定模板ID查询，查询参数都为空则默认查询账号下所有模板示例值：["tmpl-1"]
TmplName	否	String	指定模板名称查询，查询参数都为空则默认查询账号下所有模板示例值：自定义模板
NoticeID	否	String	指定通知模板ID查询，查询参数都为空则默认查询账号下所有模板示例值：notice-xxx
TmplLanguage	否	String	模板语言 en/zh 缺省不过滤示例值：zh
MonitorType	否	String	监控类型示例值：MT_QCE

3. 输出参数

参数名称	类型	描述
NoticeContentTmpls	Array of NoticeContentTmpl	自定义通知内容模板注意：此字段可能返回 null，表示取不到有效值。
NoticeContentTmplBindPolicyCounts	Array of NoticeContentTmplBindPolicyCount	通知内容模板绑定的告警策略数量
PageNumber	Integer	分页数示例值：0
PageSize	Integer	分页大小示例值：0
TotalCount	Integer	结果总数示例值：0
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询模板

测试环境真实测试

输入示例

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

{
    "PageNumber": 1,
    "PageSize": 10
}

输出示例

{
    "Response": {
        "NoticeContentTmpls": [
            {
                "CreateTime": 1731856982,
                "Creator": "700000233161",
                "LastModifier": "700000233161",
                "MonitorType": "MT_QCE",
                "TmplContents": {
                    "DingDingRobot": [
                        {
                            "MatchingStatus": [
                                "Trigger"
                            ],
                            "Template": {
                                "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                            }
                        }
                    ],
                    "FeiShuRobot": [
                        {
                            "MatchingStatus": [
                                "Trigger"
                            ],
                            "Template": {
                                "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                            }
                        }
                    ],
                    "QCloudYehe": [
                        {
                            "MatchingStatus": [
                                "Trigger"
                            ],
                            "Template": {
                                "Andon": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "Email": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "QYWX": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "SMS": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "Site": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "Voice": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "WeChat": {}
                            }
                        }
                    ],
                    "WeWorkRobot": [
                        {
                            "MatchingStatus": [
                                "Trigger"
                            ],
                            "Template": {
                                "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0="
                            }
                        }
                    ]
                },
                "TmplID": "ntpl-3r1spzjn",
                "TmplName": "Eric-test-1117-2236",
                "UpdateTime": 1731856982
            },
            {
                "CreateTime": 1731856525,
                "Creator": "700000233161",
                "LastModifier": "700000233161",
                "MonitorType": "MT_QCE",
                "TmplContents": {
                    "DingDingRobot": [
                        {
                            "MatchingStatus": [
                                "Trigger"
                            ],
                            "Template": {
                                "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                            }
                        }
                    ],
                    "FeiShuRobot": [
                        {
                            "MatchingStatus": [
                                "Trigger"
                            ],
                            "Template": {
                                "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                            }
                        }
                    ],
                    "QCloudYehe": [
                        {
                            "MatchingStatus": [
                                "Trigger"
                            ],
                            "Template": {
                                "Andon": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "Email": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0KCuaNouihjOWQjuWPiOS/ruaUueS6hnt7LlRlc3R9fQ==",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "QYWX": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "SMS": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "Site": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "Voice": {
                                    "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0=",
                                    "TitleTmpl": "RXJpY+a1i+ivleagh+mimOaooeadv3t7LlRlc3R9fQ=="
                                },
                                "WeChat": {}
                            }
                        }
                    ],
                    "WeWorkRobot": [
                        {
                            "MatchingStatus": [
                                "Trigger"
                            ],
                            "Template": {
                                "ContentTmpl": "RXJpY+a1i+ivleaooeadv3t7LlRlc3R9fQrov5nmmK/mjaLooYzlkI7nmoTlhoXlrrl7ey5UZXN0fX0KCuaNouihjOWQjuWPiOS/ruaUueS6hnt7LlRlc3R9fQ=="
                            }
                        }
                    ]
                },
                "TmplID": "ntpl-k3auv6kz",
                "TmplName": "Eric-test-1117-2318-修改",
                "UpdateTime": 1731857083
            }
        ],
        "PageNumber": 1,
        "PageSize": 1,
        "RequestId": "c57eea76-c4d5-472c-a748-605ea1805feb",
        "TotalCount": 3
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。