获取告警历史

最近更新时间：2024-03-12 01:18:13

我的收藏

本页目录：

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 查询未恢复告警

查询指定时间段内尚未恢复的告警

输入示例

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

{
    "Offset": 0,
    "Limit": 20,
    "From": 1681401600000,
    "To": 1681487999999,
    "Filters": [
        {
            "Key": "status",
            "Values": [
                "0"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "Records": [
            {
                "RecordId": "977c26df-d47f-404c-b0d2-c9ccd73f1407",
                "AlarmId": "alarm-98ba728c-3888-4049-b510-20e26de53894",
                "AlarmName": "TKE Demo事件日志告警策略_100001001014",
                "TopicId": "0337bf0c-7a38-456a-bd59-ba2feaa55195",
                "TopicName": "TKE Demo事件日志日志主题_100001001014",
                "Region": "ap-chongqing",
                "Trigger": "$1.Warning事件数 > 0",
                "TriggerCount": 1,
                "AlarmPeriod": 15,
                "Notices": [
                    {
                        "Name": "TKE Demo事件日志通知渠道组_100001001014",
                        "AlarmNoticeId": "notice-117dbad3-cc1b-4455-b112-76b0658dddc2"
                    }
                ],
                "Duration": 90,
                "Status": 0,
                "CreateTime": 1681439122000,
                "AlarmLevel": 0,
                "MonitorObjectType": 0,
                "GroupTriggerCondition": []
            },
            {
                "RecordId": "1be40239-505f-4f1a-a6aa-4b71a9757d8a",
                "AlarmId": "alarm-7be9386d-01e9-4b8b-a54e-fe00f6b15b1d",
                "AlarmName": "TKE Demo审计日志告警策略_100001001014",
                "TopicId": "6a4adc63-d145-4da4-a0e7-72bb1a9f8fcd",
                "TopicName": "TKE Demo审计日志日志主题_100001001014",
                "Region": "ap-chongqing",
                "Trigger": "$1.操作次数 >10",
                "TriggerCount": 1,
                "AlarmPeriod": 15,
                "Notices": [
                    {
                        "Name": "TKE Demo审计日志通知渠道组_100001001014",
                        "AlarmNoticeId": "notice-f7d09113-b870-4f98-b99d-38d8ecf5393b"
                    }
                ],
                "Duration": 90,
                "Status": 0,
                "CreateTime": 1681438941000,
                "AlarmLevel": 0,
                "MonitorObjectType": 0,
                "GroupTriggerCondition": []
            }
        ],
        "TotalCount": 2,
        "RequestId": "431449a5-95ab-4168-9a0e-7db48692d917"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.TagQpsLimit	请求标签服务限频。
FailedOperation.Timeout	操作超时
InternalError	内部错误。
InternalError.SearchError	检索错误
InternalError.SearchFailed	检索失败
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.ACLFailed	ACL校验失败。
OperationDenied.AccountNotExists	账户不存在。

上一篇: 获取通知渠道组列表下一篇: 获取告警策略执行详情