查询单个通知模板的详情

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

1. 接口描述

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

查询单个通知模板的详情

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

接口更新时间：2021-03-16 18:31:33。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeAlarmNotice
Version	是	否	String	公共参数，本接口取值：2018-07-24
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Module	是	否	String	模块名，这里填“monitor” 示例值： monitor
NoticeId	是	否	String	告警通知模板 id 示例值： notice-2g892hg8

3. 输出参数

参数名称	类型	描述
Notice	AlarmNotice	告警通知模板详细信息示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 查询单个通知模板的详情

查询告警通知模板ID为"notice-2g892hg8"的告警通知模板详情

输入示例

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

{
    "Module": "monitor", 
    "NoticeId": "notice-2g892hg8"
}

https://monitor.api3.fincloud.tencent.cn/?Action=DescribeAllNamespaces&Module="monitor"&NoticeId="1598976507"&ids="1598976507"&MonitorTypes="1000000"
&<公共请求参数>

输出示例

{
    "Response":{
        "RequestId":"fasdfaghash434stsi579ah",
        "Notice": {
                "Id":"notice-2g892hg8",
                "Name":"测试-告警通知规则1",
                "UpdatedAt":"2020-05-01 12:00:00",
                "UpdatedBy":"112051051047",
                "NoticeType":"ALL",
                "NoticeLanguage":"zh-CN",
                "UserNotices":[
                    {
                        "ReceiverType":"USER",
                        "UserIds":[
                            168105,
                            162208
                        ],
                        "GroupIds":[

                        ],
                        "StartTime":0,
                        "EndTime":3600,
                        "NoticeWay":[
                            "EMAIL",
                            "CALL"
                        ],
                        "PhoneOrder":[
                            162208,
                            168105
                        ],
                        "PhoneCircleTimes":2,
                        "PhoneInnerInterval":60,
                        "PhoneCircleInterval":60,
                        "NeedPhoneArriveNotice":1
                    }
                ],
                "URLNotices":[
                    {
                        "URL":"http://www.baidu.com/validate",
                        "IsValid":0,
                        "ValidationCode":"1r51tg3"
                    },
                    {
                        "URL":"https://www.googe.com/validate",
                        "IsValid":0,
                        "ValidationCode":"h4224"
                    }
                ],
                "IsPreset":0,
                "PolicyIds": ["policy-58hbt18"]
            }
    }
}