告警2.0-告警历史列表

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

1. 接口描述

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

告警2.0-告警历史列表

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

接口更新时间：2025-07-22 18:10:52。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeAlarmHistories
Version	是	否	String	公共参数，本接口取值：2018-07-24
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
PageNumber	否	否	Int64	页数，从 1 开始计数，默认 1 示例值： 1
PageSize	否	否	Int64	每页的数量，取值1~100，默认20 示例值： 20
Order	否	否	String	默认按首次出现时间倒序排列 "ASC"=正序 "DESC"=逆序示例值： DESC
StartTime	否	否	Int64	起始时间，默认一天前的时间戳示例值： 1611600000
EndTime	否	否	Int64	结束时间，默认当前时间戳示例值： 1611650000
MonitorTypes	否	否	Array of String	根据监控类型过滤不选默认查所有类型 "MT_QCE"=云产品监控 "MT_CUSTOM"=自定义监控 "MT_PROME"=prometheus监控示例值： MT_QCE
AlarmObject	否	否	String	根据告警对象过滤字符串模糊搜索示例值： tdsqlshard-h2phzy69
AlarmStatus	否	否	Array of String	根据告警状态过滤 ALARM=未恢复 OK=已恢复 NO_CONF=已失效 NO_DATA=数据不足，不选默认查所有示例值： ALARM
ProjectIds	否	否	Array of Int64	根据项目ID过滤，-1=“-“项目 0=默认项目示例值： 10
InstanceGroupIds	否	否	Array of Int64	根据实例组ID过滤示例值： 10
Namespaces	否	否	MonitorTypeNamespace	根据策略类型过滤示例值：查看
PolicyName	否	否	String	根据策略名称模糊搜索示例值：测试
Content	否	否	String	根据告警内容模糊搜索示例值： abc
ReceiverUids	否	否	Array of Int64	根据接收人搜索示例值： 1234
ReceiverGroups	否	否	Array of Int64	根据接收组搜索示例值： 1234
Module	是	否	String	固定值，为"monitor" 示例值： monitor
PolicyIds	否	否	Array of String	根据告警策略 Id 列表搜索示例值： policy-abcedf
MetricNames	否	否	Array of String	根据指标名过滤示例值： CpuUsage
UniqueIds	否	否	Array of String	根据告警实例 UniqueId 搜索示例值： dadeqe13czc
Dimensions	否	否	String	实例的维度信息示例值： [[{"name":"unInstanceId","value":"ins-abcdef"}]]
AlarmLevel	否	否	Array of String	告警等级示例值： Remind

3. 输出参数

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

4. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
LimitExceeded	超过配额限制。
InvalidParameterValue	无效的参数值。
MissingParameter	缺少参数错误。

5. 示例

示例1 获取告警历史列表

输入示例

https://monitor.api3.fincloud.tencent.cn/?Action=DescribeAlarmHistories
&Module=monitor
&PageNumber=1
&PageSize=100
&Order=DESC
&StartTime=1598976507
&EndTime=1599019707
&AlarmObject=object
&MonitorTypes.0=MT_QCE
&AlarmStatus.0=ALARM
&ProjectIds.0=0
&InstanceGroupIds.0=0
&MetricNames.0=mem_used
&PolicyName=policy
&Content=content
&ReceiverUids.0=10000
&ReceiverGroups.0=10000
&Namespaces.0.MonitorType=MT_QCE
&Namespaces.0.Namespace=cvm_device
&<公共请求参数>

输出示例

{
    "TotalCount":2,
    "Histories": [
        {
            "AlarmId": "g34jgh3-t3cc3c23-cv23vc234c",
            "MonitorType": "MT_QCE_METRIC",
            "Namespace": "cvm_device",
            "AlarmObject": "9.142.151.35",
            "Content": "CPU 利用率 >= 99.99%",
            "FirstOccurTime": 1597240790,
            "LastOccurTime": 1597250790,
            "AlarmStatus": "ALARM",
            "PolicyId": "195491",
            "PolicyName": "告警策略",
            "VPC": "-",
            "ProjectId": 0,
            "ProjectName": "默认项目",
            "InstanceGroup": [
                {
                    "Id": 123,
                    "Name": "我是一个实例组"
                }
            ],
            "ReceiverUids": [1451455,125151,616677],
            "ReceiverGroups": [],
            "NoticeWays": ["SMS", "EMAIL"],
            "OriginId": "100"
        },
        {
            "AlarmId": "g34jgh3-t3cc3c23-ag4hg3y3h2",
            "MonitorType": "MT_CUSTOM",
            "Namespace": "custom_test_space",
            "AlarmObject": "host = 127.0.0.1",
            "Content": "告警",
            "FirstOccurTime": 1597240790,
            "LastOccurTime": 1597250790,
            "AlarmStatus": "ALARM",
            "PolicyId": "195492",
            "PolicyName": "告警策略",
            "VPC": "-",
            "ProjectId": -1,
            "ProjectName": "-",
            "InstanceGroup": [],
            "ReceiverUids": [],
            "ReceiverGroups": [12345,56789],
            "NoticeWays": ["CALL"],
            "OriginId": "policy-msjftixf"
        }
    ]
}