获取产品事件列表
最近更新时间: 2024-10-18 10:38:30
1. 接口描述
接口请求域名： monitor.api3.fincloud.tencent.cn。
分页获取产品事件的列表
默认接口请求频率限制：20次/秒。
接口更新时间：2020-01-02 10:12:28。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeProductEventList |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-07-24 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Module | 是 | 否 | String | 接口模块名，固定值"monitor" |
| ProductName | 否 | 否 | Array of String | 产品类型过滤，比如"cvm"表示云服务器 |
| EventName | 否 | 否 | Array of String | 事件名称过滤，比如"guest_reboot"表示机器重启 |
| InstanceId | 否 | 否 | Array of String | 影响对象，比如ins-19708ino |
| Dimensions | 否 | 否 | Array of DescribeProductEventListDimensions | 维度过滤，比如外网IP:10.0.0.1 |
| RegionList | 否 | 否 | Array of String | 地域过滤，比如gz |
| Type | 否 | 否 | Array of String | 事件类型过滤，取值范围["status_change","abnormal"]，分别表示状态变更、异常事件 |
| Status | 否 | 否 | Array of String | 事件状态过滤，取值范围["recover","alarm","-"]，分别表示已恢复、未恢复、无状态 |
| Project | 否 | 否 | Array of String | 项目ID过滤 |
| IsAlarmConfig | 否 | 否 | Int64 | 告警状态配置过滤，1表示已配置，0表示未配置 |
| TimeOrder | 否 | 否 | String | 按更新时间排序，ASC表示升序，DESC表示降序，默认DESC |
| StartTime | 否 | 否 | Int64 | 起始时间，默认一天前的时间戳 |
| EndTime | 否 | 否 | Int64 | 结束时间，默认当前时间戳 |
| Offset | 否 | 否 | Int64 | 页偏移量，默认0 |
| Limit | 否 | 否 | Int64 | 每页返回的数量，默认20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Events | DescribeProductEventListEvents | 事件列表 |
| OverView | DescribeProductEventListOverView | 事件统计 |
| Total | Int64 | 事件总数 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InternalError | |
| InvalidParameter.InvalidParameterParam | |
| InvalidParameter.InvalidParameter | |
| InvalidParameter | |
| MissingParameter | |
| LimitExceeded |