获取基础告警列表

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

1. 接口描述

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

获取基础告警列表

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

接口更新时间：2020-09-25 15:17:37。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeBasicAlarmList
Version	是	否	String	公共参数，本接口取值：2018-07-24
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Module	是	否	String	接口模块名，当前取值monitor 示例值： monitor
StartTime	否	否	Int64	起始时间，默认一天前的时间戳示例值： 1573660800
EndTime	否	否	Int64	结束时间，默认当前时间戳示例值： 1573919999
Limit	否	否	Int64	分页参数，每页返回的数量，取值1~100，默认20 示例值： 20
Offset	否	否	Int64	分页参数，页偏移量，从0开始计数，默认0 示例值： 0
OccurTimeOrder	否	否	String	根据发生时间排序，取值ASC或DESC 示例值： DESC
ProjectIds	否	否	Array of Int64	根据项目ID过滤示例值： ["0"]
ViewNames	否	否	Array of String	根据策略类型过滤示例值： ["cvm_device"]
AlarmStatus	否	否	Array of Int64	根据告警状态过滤示例值： ["1"]
ObjLike	否	否	String	根据告警对象过滤示例值： 123
InstanceGroupIds	否	否	Array of Int64	根据实例组ID过滤示例值： [11233]

3. 输出参数

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

4. 错误码

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

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

5. 示例

示例1 获取基础告警列表

输入示例

https://monitor.api3.fincloud.tencent.cn/?Action=DescribeBasicAlarmList
&Module=monitor
&StartTime=1573660800
&EndTime=1573919999
&Limit=20
&Offset=0
&OccurTimeOrder=DESC
&ProjectIds.0=0
&ViewNames.0=cvm_device
&AlarmStatus.0=1
&<公共请求参数>

输出示例

{
    "Response": {
        "Alarms": [
            {
                "AlarmStatus": "OK",
                "AlarmType": "内存使用量",
                "Content": "内存使用量 >  66666 MB",
                "Dimensions": "{\"unInstanceId\":\"ins-19a06nn8\"}",
                "Duration": 600,
                "FirstOccurTime": "2019-11-16T15:50:00+08:00",
                "GroupId": 1278966,
                "GroupName": "dddd",
                "Id": 30057956,
                "InstanceGroup": [
                    {
                        "InstanceGroupId": 562,
                        "InstanceGroupName": "barad_nws_cvm"
                    }
                ],
                "LastOccurTime": "2019-11-16T16:00:00+08:00",
                "MetricId": 24,
                "MetricName": "mem_used",
                "NotifyWay": [
                    "EMAIL",
                    "SMS"
                ],
                "ObjId": "a961c198-e0e2-4989-a3b6-7b155b35ff6f",
                "ObjName": "10.0.0.14(251008737 vm1)",
                "ProjectId": 0,
                "ProjectName": "默认项目",
                "Region": "gz",
                "Status": 1,
                "ViewName": "cvm_device",
                "Vpc": "1"
            },
            {
                "AlarmStatus": "OK",
                "AlarmType": "内存使用量",
                "Content": "内存使用量 >=  200000 MB",
                "Dimensions": "{\"unInstanceId\":\"ins-19a06nn8\"}",
                "Duration": 180,
                "FirstOccurTime": "2019-11-16T15:45:00+08:00",
                "GroupId": 1279043,
                "GroupName": "-",
                "Id": 30057955,
                "InstanceGroup": [
                    {
                        "InstanceGroupId": 562,
                        "InstanceGroupName": "barad_nws_cvm"
                    }
                ],
                "LastOccurTime": "2019-11-16T15:48:00+08:00",
                "MetricId": 24,
                "MetricName": "mem_used",
                "NotifyWay": [
                    "EMAIL",
                    "SMS",
                    "WECHAT"
                ],
                "ObjId": "a961c198-e0e2-4989-a3b6-7b155b35ff6f",
                "ObjName": "10.0.0.14(251008737 vm1)",
                "ProjectId": 0,
                "ProjectName": "默认项目",
                "Region": "gz",
                "Status": 1,
                "ViewName": "cvm_device",
                "Vpc": "1"
            }
        ],
        "RequestId": "6b64cc24-0c60-483f-bdc3-2e55edbbc68c",
        "Total": 2
    }
}