1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
获取平台事件列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAccidentEventList。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Module | 是 | String | 接口模块名,当前接口取值monitor |
StartTime | 否 | Integer | 起始时间,默认一天前的时间戳 |
EndTime | 否 | Integer | 结束时间,默认当前时间戳 |
Limit | 否 | Integer | 分页参数,每页返回的数量,取值1~100,默认20 |
Offset | 否 | Integer | 分页参数,页偏移量,从0开始计数,默认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)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取平台事件列表
获取平台事件列表
输入示例
https://monitor.tencentcloudapi.com/?Action=DescribeAccidentEventList
&Module=monitor
&<公共请求参数>
输出示例
{
"Response": {
"Alarms": [
{
"OccurTime": "2019-10-10T15:03:31+08:00",
"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 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
UnsupportedOperation | 操作不支持。 |