获取基础告警列表

最近更新时间:2020-03-18 08:01:08

1. 接口描述

接口请求域名: monitor.tencentcloudapi.com 。

获取基础告警列表

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:monitor.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBasicAlarmList。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 接口模块名,当前取值monitor
StartTime Integer 起始时间,默认一天前的时间戳
EndTime Integer 结束时间,默认当前时间戳
Limit Integer 分页参数,每页返回的数量,取值1~100,默认20
Offset Integer 分页参数,页偏移量,从0开始计数,默认0
OccurTimeOrder String 根据发生时间排序,取值ASC或DESC
ProjectIds.N Array of Integer 根据项目ID过滤
ViewNames.N Array of String 根据策略类型过滤
AlarmStatus.N Array of Integer 根据告警状态过滤
ObjLike String 根据告警对象过滤
InstanceGroupIds.N Array of Integer 根据实例组ID过滤

3. 输出参数

参数名称 类型 描述
Alarms Array of DescribeBasicAlarmListAlarms 告警列表
注意:此字段可能返回 null,表示取不到有效值。
Total Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取基础告警列表

输入示例

https://monitor.tencentcloudapi.com/?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
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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