有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

查询单个通知模板的详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAlarmNotice。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 模块名,这里填“monitor”
示例值:monitor
NoticeId String 告警通知模板 id
示例值:notice-2g892hg8

3. 输出参数

参数名称 类型 描述
Notice AlarmNotice 告警通知模板详细信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

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

输入示例

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

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

输出示例

{
    "Response": {
        "Notice": {
            "AMPConsumerId": "xx",
            "URLNotices": [
                {
                    "ValidationCode": "xx",
                    "URL": "xx",
                    "IsValid": 0,
                    "Weekday": [
                        0
                    ],
                    "StartTime": 0,
                    "EndTime": 0
                },
                {
                    "ValidationCode": "xx",
                    "URL": "xx",
                    "IsValid": 0,
                    "Weekday": [
                        0
                    ],
                    "StartTime": 0,
                    "EndTime": 0
                }
            ],
            "Name": "xx",
            "NoticeType": "xx",
            "CLSNotices": [
                {
                    "TopicId": "xx",
                    "Region": "xx",
                    "Enable": 0,
                    "LogSetId": "xx"
                }
            ],
            "UpdatedBy": "xx",
            "PolicyIds": [
                "policy-58hbt18"
            ],
            "UserNotices": [
                {
                    "NoticeWay": [
                        "EMAIL",
                        "CALL"
                    ],
                    "NeedPhoneArriveNotice": 1,
                    "PhoneOrder": [
                        162208,
                        168105
                    ],
                    "PhoneCallType": "xx",
                    "UserIds": [
                        168105,
                        162208
                    ],
                    "ReceiverType": "xx",
                    "PhoneCircleInterval": 60,
                    "GroupIds": [
                        0
                    ],
                    "StartTime": 0,
                    "PhoneCircleTimes": 2,
                    "EndTime": 3600,
                    "PhoneInnerInterval": 60,
                    "Weekday": [
                        0
                    ]
                }
            ],
            "IsPreset": 0,
            "UpdatedAt": "xx",
            "NoticeLanguage": "xx",
            "Id": "xx"
        },
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.DoHTTPTransferFailed 后端服务超时
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。