1. 接口描述
接口请求域名: es.tencentcloudapi.com 。
查询事件中心列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeEsInstanceEventLists。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Limit | 是 | Integer | 返回数量,默认为20,最大值为100。 示例值:20 |
| Offset | 是 | Integer | 偏移量,默认为0。 示例值:0 |
| StartTime | 是 | String | 起始时间, e.g. "2019-03-07 16:30:39" 示例值:2018-01-01 00:00:00 |
| EndTime | 是 | String | 结束时间, e.g. "2019-03-30 20:18:03" 示例值:2025-03-20 23:59:59 |
| InstanceIds.N | 否 | Array of String | 集群id,非必填,查询集群相关的事件 示例值:["es-*"] |
| EventTypes.N | 否 | Array of Integer | 查询的类型,包括:硬件异常、用户变更和智能运维等,默认查询所有。1:硬件异常;2:用户变更;3:智能运维 示例值:[1,2,3] |
| EventStatus.N | 否 | Array of Integer | 事件状态 示例值:[0,1,2] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 事件中心记录总数 示例值:20 |
| EventDataInfoList | Array of EventDataInfoOverview | 事件中心记录信息 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeEsInstanceEventLists接口请求示例
输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEsInstanceEventLists
<公共请求参数>
{
"EndTime": "2025-08-06 20:56:38",
"Limit": 10,
"Offset": 0,
"StartTime": "2025-07-30 20:56:38"
}
输出示例
{
"Response": {
"TotalCount": 1,
"EventDataInfoList": [
{
"EventType": 2,
"EventTaskId": 16676,
"EventName": "ModifyInstance",
"EventContent": "{\"OldInfo\":[{\"Key\":\"MasterNodeType\",\"Value\":\"ES.S1.MEDIUM8\"}],\"NewInfo\":[{\"Key\":\"MasterNodeType\",\"Value\":\"ES.S1.MEDIUM4\"}]}",
"InstanceId": "es-*****",
"InstanceName": "************",
"NodeId": "",
"NodeRole": "",
"EventStatus": 2,
"StartTime": "2025-08-06 20:54:01",
"EndTime": "2025-08-07 20:54:01"
}
],
"RequestId": "*******************************"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidUin | Uin的取值和预期不符。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |