1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
获取告警信息列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListAlarmMessages。 |
| Version | 是 | String | 公共参数，本接口取值：2025-08-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 所属项目id 示例值：1859317240494305280 |
| PageNumber | 否 | Integer | 页码数，用于翻页，最小值为 1。 示例值：1 |
| PageSize | 否 | Integer | 每页显示的条数，最大 100 条 示例值：20 |
| StartTime | 否 | String | 起始告警时间, 格式为yyyy-MM-dd HH:mm:ss 示例值：1971-01-01 00:00:00 |
| EndTime | 否 | String | 截止告警时间, 格式yyyy-MM-dd HH:mm:ss 示例值：2025-08-11 17:31:19 |
| AlarmLevel | 否 | Integer | 告警级别 示例值：1 |
| AlarmRecipientId | 否 | String | 告警接收人Id 示例值：100042232112 |
| TimeZone | 否 | String | 对于传入和返回的过滤时区, 默认UTC+8 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | ListAlarmMessages | 告警信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 ListAlarmMessages
获取告警信息列表
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListAlarmMessages
<公共请求参数>
{
"ProjectId": "1460947878944567296",
"PageNumber": 1,
"PageSize": 20,
"StartTime": "2025-09-08 16:00:00",
"EndTime": "2025-09-08 17:00:00",
"AlarmLevel": 1,
"AlarmRecipientId": "100042232112"
}输出示例
{
"Response": {
"Data": {
"PageNumber": 1,
"PageSize": 20,
"TotalCount": 100,
"TotalPageNumber": 5,
"Items": [
{
"AlarmLevel": 3,
"AlarmMessageId": 20,
"AlarmReason": "4",
"AlarmRecipients": [
"mytestdd"
],
"AlarmRuleId": "8f258dac-19e4-45c2-ac85-1e69c8626b89",
"AlarmTime": "2025-08-09 15:00:00",
"AlarmWays": [
"email",
"sms"
],
"CurRunDate": "2022-08-16 00:05:00",
"TaskId": "20220822133437682",
"TaskName": "alarm_cycleNotCompleted_test"
}
]
},
"RequestId": "2022a62a-f8ca-4cc8-8c74-b56191d2d766"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
