查询告警通知历史-APIs-Tencent Cloud

1. 接口描述

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

按需查询告警的通知历史

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAlarmNotifyHistories。
Version	是	String	公共参数，本接口取值：2023-06-16。
Region	否	String	公共参数，此参数为可选参数。
MonitorType	是	String	监控类型示例值：MT_PROME
QueryBaseTime	是	Integer	起始时间点，unix秒级时间戳示例值：1732801290
QueryBeforeSeconds	是	Integer	从 QueryBaseTime 开始，需要查询往前多久的时间，单位秒示例值：1800
PageParams	是	PageByNoParams	分页参数
Namespace	否	String	当监控类型为 MT_QCE 时候需要填写，归属的命名空间示例值：qce/cvm
ModelName	否	String	当监控类型为 MT_QCE 时候需要填写，告警策略类型示例值：cvm_device
PolicyId	否	String	查询某个策略的通知历史示例值：policy-123

3. 输出参数

参数名称	类型	描述
AlarmNotifyHistoryList	Array of AlarmNotifyHistory	告警历史
PageResult	PageByNoResult	分页情况
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询Prometheus通知历史

输入示例

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

{
    "MonitorType": "MT_PROME",
    "QueryBaseTime": 1734576676,
    "QueryBeforeSeconds": 172000,
    "PageParams": {
        "PerPage": 1,
        "PageNo": "1"
    }
}

输出示例

{
    "Response": {
        "AlarmNotifyHistoryList": [
            {
                "AlarmContent": "这是消息体\n这是消息体第二行\n<font color=\"green\">这是绿色的消息体</font>",
                "AlarmObject": "新amp接口告警",
                "ChannelSet": [
                    "DingDing",
                    "FeiShu",
                    "WeWork",
                    "WebHook"
                ],
                "ChannelsReceivers": [
                    {
                        "ChannelName": "DingDing",
                        "Receivers": [
                            "https://oapi.dingtalk.com/robot/send?access_token=c1090c31391e5766b6e509d6ed0ac9930447231f8c151a5b8aa61ffb637db3ec"
                        ],
                        "SendStatus": "NotifyChannelExecSucc"
                    },
                    {
                        "ChannelName": "FeiShu",
                        "Receivers": [
                            "https://open.feishu.cn/open-apis/bot/v2/hook/58151696-a863-47e8-ae49-dfa982e48b25"
                        ],
                        "SendStatus": "NotifyChannelExecSucc"
                    },
                    {
                        "ChannelName": "QCloudYehe",
                        "Receivers": [
                            "907876075",
                            "906793755"
                        ],
                        "SendStatus": "NotifyChannelExecSucc"
                    },
                    {
                        "ChannelName": "WeWork",
                        "Receivers": [
                            "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=12d11141-d6e8-44df-b00e-03285ad65415"
                        ],
                        "SendStatus": "NotifyChannelExecSucc"
                    },
                    {
                        "ChannelName": "WebHook",
                        "Receivers": [
                            "http://118.24.173.149:9090/test/sendAlerts"
                        ],
                        "SendStatus": "NotifyChannelExecSucc"
                    }
                ],
                "Notices": [
                    {
                        "NoticeId": "notice-625w0q92",
                        "NoticeName": "Prom通知测试企微机器人"
                    }
                ],
                "NotifyId": "b476ba3696525213f0c88033e56e8675_c1u82",
                "NotifyTime": 1734497292,
                "PolicyId": "alert-p8yurlq0",
                "PolicyName": "能收到吗/aaaaa",
                "PromeInstanceID": "prom-pysf4frm",
                "PromeInstanceRegion": "ap-guangzhou",
                "SessionId": "prom-pysf4frm_3ef6b8b216aa56e9",
                "TriggerLevel": "Invalid",
                "TriggerStatus": "Recovery",
                "TriggerTime": 1734491764
            }
        ],
        "PageResult": {
            "CurrentPageNo": 1,
            "IsEnd": false,
            "TotalCount": 19,
            "TotalPage": 19
        },
        "RequestId": "efc734bb-1caa-4a4f-a159-97115b57125a"
    }
}

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. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。

查询告警通知历史

On this page: