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 |
| NotifyId | 否 | String | 详情页展示所需id 示例值:f29a30fb731ba2c5c2afaf0379e40201_c29hs |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AlarmNotifyHistoryList | Array of AlarmNotifyHistory | 告警历史 |
| PageResult | PageByNoResult | 分页情况 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 云产品监控详情页示例
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmNotifyHistories
<公共请求参数>
{
"MonitorType": "MT_QCE",
"QueryBaseTime": 1791445402,
"QueryBeforeSeconds": 3600,
"PageParams": {
"PerPage": 20,
"PageNo": "1"
},
"NotifyId": "f29a30fb731ba2c5c2afaf0379e40201_c**hs"
}
输出示例
{
"Response": {
"AlarmNotifyHistoryList": [
{
"AlarmContent": "CPU利用率 > 0%",
"AlarmObject": "172.16.0.45 (内) | ins-3vpoml9k | chengming-勿删勿动-长期使用(研发大佬请用) | vpcId: vpc-4wyuws75",
"ChannelSet": [
"QCloudYehe_email"
],
"ChannelsReceivers": [
{
"ChannelName": "QCloudYehe",
"Contents": [
{
"Content": "【TCOP】【告警触发】云产品告警详情页测试\n尊敬的腾讯云用户,您好!\n\n 您的腾讯云账号(账号ID:1500000686,昵称:686_nickname)的云产品监控告警触发。\n\n告警内容:云服务器-基础监控 | CPU利用率 > 0% \n告警对象:172.16.0.45 (内) | ins-3vpoml9k | chengming-勿删勿动-长期使用(研发大佬请用) | vpcId: vpc-4wyuws75\n当前数据:0.85% (CPU利用率)\n项目|地域:默认项目 | 广州\nAPPID:251005942\n告警策略:云产品告警详情页测试\n触发时间:2026-10-08 16:49:00 (UTC+08:00)\n告警说明:CPU 利用率过高会容易引起服务响应速度变慢、服务器登录不上等问题。可能由硬件、系统进程、业务进程或者木马病毒等因素所致。详见排查指引https://cloud.tencent.com/document/product/248/44698 \n\n此致 \n腾讯云团队",
"SubChannel": "QCloudYehe_email"
}
],
"ExecDetail": "",
"RealDeliverErrMsg": "",
"RealDeliverStatus": "",
"RealDeliverTime": "",
"Receivers": [
"906911493"
],
"SendStatus": "NotifyChannelExecSucc",
"SendStatusCode": "OK_0",
"SendTime": 1791449424,
"SubChannels": [
"QCloudYehe_email"
]
}
],
"Labels": [
{
"Name": "BaradAlarm_appid",
"Value": "251005942"
}
],
"Notices": [
{
"NoticeId": "notice-67tqbxsn",
"NoticeName": "系统预设通知模板"
}
],
"NotifyId": "f29a30fb731ba2c5c2afaf0379e40201_c29hs",
"NotifyTime": 1791449424,
"PolicyId": "policy-6a7jmi0d",
"PolicyName": "云产品告警详情页测试",
"PromeConsoleURL": "",
"PromeInstanceID": "",
"PromeInstanceRegion": "",
"ReceiverGroups": [
{
"ChannelNames": [
"QCloudYehe_email"
],
"DayEndSeconds": 86399,
"DayStartSeconds": 0,
"MemberIds": null,
"Names": [
"log_test2"
],
"ReceiverIds": [
"906911493"
],
"ReceiverType": "UIDs",
"TimeZoneName": "",
"WeekDay": [
0
]
}
],
"SessionId": "r_gz_2149202746_13c263af2fd1a2ef8cea0f3a7609a29f_65041",
"TriggerLevel": "None",
"TriggerStatus": "Trigger",
"TriggerTime": 1791449340
}
],
"PageResult": {
"CurrentPageNo": 1,
"IsEnd": true,
"TotalCount": 1,
"TotalPage": 1
},
"RequestId": "e33f23d5-da28-45fb-91db-9ccecd0793d3"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |