告警历史记录

最近更新时间: 2026-09-17 00:06:36

1. 接口描述

接口请求域名： cls.api3.fincloud.tencent.cn。

告警历史记录

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

接口更新时间：2025-01-14 19:59:26。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeAlertRecordHistory
Version	是	否	String	公共参数，本接口取值：2020-10-16
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Filters	否	否	Array of Filter	alertId：按照告警策略ID进行过滤。类型：String 必选：否 topicId：按照监控对象ID进行过滤。类型：String 必选：否 status：按照告警状态进行过滤。类型：String 必选：否，0代表未恢复，1代表已恢复，2代表已失效 alarmLevel：按照告警等级进行过滤。类型：String 必选：否，0代表警告，1代表提醒，2代表紧急每次请求的Filters的上限为10，Filter.Values的上限为100。示例值：查看
From	是	否	Uint64	查询时间范围启始时间，毫秒级unix时间戳示例值： 1619063300000
To	是	否	Uint64	查询时间范围结束时间，毫秒级unix时间戳示例值： 1619581700000
Offset	是	否	Int64	分页的偏移量，默认值为0。示例值： 0
Limit	是	否	Int64	分页单页限制数目，最大值100。示例值： 10

3. 输出参数

参数名称	类型	描述
TotalCount	Int64	告警历史总数示例值： 1
Records	Array of AlertHistoryRecord	告警历史详情示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
InternalError	内部错误。
OperationDenied	操作被拒绝。
OperationDenied.ACLFailed	ACL校验失败。
OperationDenied.AccountNotExists	账户不存在。

5. 示例

示例1 告警历史记录

输入示例

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

{
    "Offset": 0,
    "Limit": 20,
    "From": 1628769979359,
    "To": 1628773579359,
    "Filters": [
        {
            "Key": "alertId",
            "Values": [
                "alarm-20c4916b-0732-40f0-95b7-f72b456e9644"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "Records": [
            {
                "RecordId": "482badcc-7090-49a7-bd98-0992b924f31f",
                "AlarmId": "alarm-20c4916b-0732-40f0-95b7-f72b456e9644",
                "AlarmName": "shicao_test",
                "TopicId": "94169a4b-bc3b-4885-8385-7e901719e88e",
                "TopicName": "shicao_test",
                "Region": "region",
                "Trigger": "$1.PV > 0",
                "TriggerCount": 1,
                "AlarmPeriod": 0,
                "Notices": [
                    {
                        "Name": "shicao_test",
                        "AlarmNoticeId": "notice-6eb201b0-395a-4abb-91c0-2a01ea0300e1"
                    }
                ],
                "Duration": 17,
                "Status": 2,
                "CreateTime": 1628770729000
            },
            {
                "RecordId": "151049b0-98b7-460f-9150-3601e7210550",
                "AlarmId": "alarm-20c4916b-0732-40f0-95b7-f72b456e9644",
                "AlarmName": "shicao_test",
                "TopicId": "94169a4b-bc3b-4885-8385-7e901719e88e",
                "TopicName": "shicao_test",
                "Region": "region",
                "Trigger": "$1.PV > 0",
                "TriggerCount": 1,
                "AlarmPeriod": 0,
                "Notices": [
                    {
                        "Name": "shicao_test",
                        "AlarmNoticeId": "notice-6eb201b0-395a-4abb-91c0-2a01ea0300e1"
                    }
                ],
                "Duration": 0,
                "Status": 2,
                "CreateTime": 1628770669000
            }
        ],
        "TotalCount": 2,
        "RequestId": "e318f277-509e-45a4-9f18-3c723e1fdf73"
    }
}