1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
获取告警历史,例如今天未恢复的告警
默认接口请求频率限制:40次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAlertRecordHistory。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
From | 是 | Integer | 查询时间范围启始时间,毫秒级unix时间戳 示例值:1619063300000 |
To | 是 | Integer | 查询时间范围结束时间,毫秒级unix时间戳 示例值:1619581700000 |
Offset | 是 | Integer | 分页的偏移量,默认值为0。 示例值:0 |
Limit | 是 | Integer | 分页单页限制数目,最大值100。 示例值:10 |
Filters.N | 否 | Array of Filter | - alertId:按照告警策略ID进行过滤。类型:String 必选:否 - topicId:按照监控对象ID进行过滤。类型:String 必选:否 - status:按照告警状态进行过滤。类型:String 必选:否,0代表未恢复,1代表已恢复,2代表已失效 - alarmLevel:按照告警等级进行过滤。类型:String 必选:否,0代表警告,1代表提醒,2代表紧急 每次请求的Filters的上限为10,Filter.Values的上限为100。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 告警历史总数 示例值:1 |
Records | Array of AlertHistoryRecord | 告警历史详情 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询未恢复告警
查询指定时间段内尚未恢复的告警
输入示例
输出示例
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.TagQpsLimit | 请求标签服务限频。 |
FailedOperation.Timeout | 操作超时 |
InternalError | 内部错误。 |
InternalError.SearchError | 检索错误 |
InternalError.SearchFailed | 检索失败 |
InvalidParameter | 参数错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.ACLFailed | ACL校验失败。 |
OperationDenied.AccountNotExists | 账户不存在。 |