1. 接口描述
接口请求域名： tbdsnew.api3.fincloud.tencent.com。
集群监控中集群事件，事件列表功能，获取当前集群发生的集群事件
默认接口请求频率限制：20次/秒。
接口更新时间：2024-12-06 07:38:02。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeEvents |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-03 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 实例ID 示例值： tbds-1vzudj86 |
| EventClass | 否 | 否 | String | 事件类型 示例值： None |
| StartTime | 否 | 否 | Int64 | 开始时间 示例值： 1748188800 |
| EndTime | 否 | 否 | Int64 | 结束时间 示例值： 1748252064 |
| Limit | 否 | 否 | Int64 | 分页大小，默认值：10，最大值：100 示例值： 10 |
| Offset | 否 | 否 | Int64 | 分页偏移量，默认值：0，表示第一页 示例值： 0 |
| OrderField | 否 | 否 | String | 排序字段，eg：start_time, latest_time 示例值： |
| OrderType | 否 | 否 | String | 排序类型，升序 asc, 降序desc 示例值： desc |
| SearchTxt | 否 | 否 | String | 查找的字符串 示例值： None |
| EventTypes | 否 | 否 | Array of String | 筛选的EventTypes 示例值： ['CpuLoad5mMoreThanThreshold'] |
| Services | 否 | 否 | Array of String | 筛选的Services 示例值： [] |
| Roles | 否 | 否 | Array of String | 筛选的Roles 示例值： [] |
| Hosts | 否 | 否 | Array of String | 筛选的Hosts 示例值： ['172.16.0.109'] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Events | String | 事件结果列表 示例值： 1 |
| ClassInfo | String | 事件类型说明，base64编码 {“"Fatal": "致命", "Critical": "严重", "Normal": "一般", }" 示例值： 1 |
| Total | Int64 | 事件结果数目 示例值： 1 |
| EventTypes | String | EventTypes的json字符串 示例值： 1 |
| Services | String | Services的json字符串 示例值： 1 |
| Roles | String | Roles的json字符串 示例值： 1 |
| Hosts | String | Hosts的json字符串 示例值： 1 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.ClickHouseQueryException | 查询ClickHouse异常。 |
| InternalError | 内部错误。 |
| InvalidParameter.ImpalaQueryException | impala查询参数异常。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |