获取平台事件列表

最近更新时间:2020-01-09 14:40:02

1. 接口描述

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

获取平台事件列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAccidentEventList。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 接口模块名,当前接口取值monitor
StartTime Integer 起始时间,默认一天前的时间戳
EndTime Integer 结束时间,默认当前时间戳
Limit Integer 每页返回的数量,默认20
Offset Integer 页偏移量,默认0
UpdateTimeOrder String 根据UpdateTime排序的规则,取值asc或desc
OccurTimeOrder String 根据OccurTime排序的规则,取值asc或desc(优先根据UpdateTimeOrder排序)
AccidentType.N Array of Integer 根据事件类型过滤,1表示服务问题,2表示其他订阅
AccidentEvent.N Array of Integer 根据事件过滤,1表示云服务器存储问题,2表示云服务器网络连接问题,3表示云服务器运行异常,202表示运营商网络抖动
AccidentStatus.N Array of Integer 根据事件状态过滤,0表示已恢复,1表示未恢复
AccidentRegion.N Array of String 根据事件地域过滤,gz表示广州,sh表示上海等
AffectResource String 根据影响资源过滤,比如ins-19a06bka

3. 输出参数

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

4. 示例

示例1 获取平台事件列表

获取平台事件列表

输入示例

https://monitor.tencentcloudapi.com/?Action=DescribeAccidentEventList
&Module=monitor
&<公共请求参数>

输出示例

{
  "Response": {
    "Data": {
      "Alarms": [
        {
          "OccurTime": "2019-10-10T15:03:31+08:00",
          "AccidentType": 23,
          "BusinessID": 1,
          "AffectResource": "ins-19708ino",
          "EventStatus": 0,
          "Region": "gz",
          "UpdateTime": "2019-10-10T15:03:31+08:00",
          "AccidentTypeDesc": "云服务器运行异常",
          "BusinessTypeDesc": "服务问题"
        }
      ],
      "Total": 1
    },
    "RequestId": "test813c-45d8-459a-8978-aaasahuiaa"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

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