获取某个事件的发生列表

最近更新时间: 2026-09-17 00:05:45

1. 接口描述

接口请求域名： tbdsnew.api3.fincloud.tencent.cn。

集群监控中集群事件，事件列表功能，点击当日触发次数，获取事件的发生列表

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

接口更新时间：2024-12-06 07:17:38。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeCertainEventList
Version 是 否 String 公共参数，本接口取值：2019-01-03
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId 是 否 String 集群实例ID
示例值： tbds-lpzpjomo
StartTime 是 否 Int64 起始时间
示例值： 1748188800
EndTime 是 否 Int64 结束时间
示例值： 1748247070
Role 是 否 String 角色
示例值： KafkaManager
Host 是 否 String 节点ip
示例值： 172.16.0.81
PageSize 是 否 Int64 页容量，默认值：10，最小值为1，表示最少加载一条数据
示例值： 10
DescByTime 是 否 Bool 是否按时间倒排，默认值：true
示例值： True
PageNum 是 否 Int64 页号，默认值：0，表示第一页
示例值： 0
EventType 是 否 String 事件类型，eg："JVMOldException"
示例值： JVMOldException
Service 是 否 String 服务名，eg："HBASE"
示例值： KAFKA
Message 否 否 String 分组事件信息，eg："RegionServer jvm old area memory usage larger than 90%"
示例值： KafkaManager jvm old area memory usage larger than 90%

3. 输出参数

参数名称 类型 描述
EventList Array of DescribeCertainEventListItem 事件列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：查看
TotalNum Int64 事件总数
示例值： 1
TotalPages Int64 总页数
示例值： 1
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
UnauthorizedOperation.AppIdMismatched appid不一致。
InternalError 内部错误。
ResourceNotFound.MetricsMetaNotFound 无法找到监控元数据。
InvalidParameter.ImpalaQueryException impala查询参数异常。
ResourceNotFound.ClusterNotFound 无法找到该实例。
InternalError.ESException ES异常。

5. 示例

示例1 获取某个事件的发生列表

输入示例

POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeCertainEventList
<公共请求参数>

{
  "InstanceId": "tbds-lpzpjomo",
  "StartTime": 1748188800,
  "EndTime": 1748247070,
  "Role": "KafkaManager",
  "Host": "172.16.0.81",
  "PageSize": 10,
  "DescByTime": true,
  "PageNum": 0,
  "EventType": "JVMOldException",
  "Service": "KAFKA",
  "Message": "KafkaManager jvm old area memory usage larger than 90%"
}

输出示例

{
  "Response": {
    "EventList": [
      {
        "TimeStamp": "2025-05-26 02:57:12",
        "Detail": "KafkaManager jvm old area memory usage larger than 90%",
        "Service": "KAFKA",
        "Role": "KafkaManager",
        "IsSupportMonitor": true
      }
    ],
    "RequestId": "fd572ca4-7bdd-450c-bebe-fb66e558bbc9",
    "TotalNum": 1,
    "TotalPages": 1
  }
}