1. 接口描述
接口请求域名: cdwch.tencentcloudapi.com 。
获取产生的事件
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeEventTasks。 |
| Version | 是 | String | 公共参数,本接口取值:2020-09-15。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群id 示例值:cdwch-yapr67z1 |
| EventTaskId | 否 | Integer | 过滤的事件任务id 示例值:27 |
| PageNumber | 否 | Integer | 页码,默认为1 示例值:1 |
| PageSize | 否 | Integer | 每页数量(支持10、20、30、50、100、200),默认为100 示例值:10 |
| EventCode | 否 | String | 事件名称过滤 示例值:DiskHigh |
| Status.N | 否 | Array of Integer | (1-待处理;2-已预约;3-处理中;4-已结束;5-处理中;-1-已忽略;-2-已删除) 示例值:[2] |
| StartTime | 否 | String | 创建时间范围开始 (格式: YYYY-MM-DD HH:MM:SS),最大支持查询180天信息 示例值:2025-01-01 00:00:00 |
| EndTime | 否 | String | 创建时间范围结束 (格式: YYYY-MM-DD HH:MM:SS) 示例值:2025-01-31 23:59:59 |
| SortField | 否 | String | 排序字段(事件类型:event_code;触发时间:create_time;完成时间:end_time) 示例值:create_time |
| SortOrder | 否 | String | 排序顺序 (asc/desc) 示例值:asc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| EventTasks | Array of EventTask | 产生的事件任务 |
| TotalCount | Integer | 事件任务总数 示例值:31 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取集群产生的事件
输入示例
POST / HTTP/1.1
Host: cdwch.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEventTasks
<公共请求参数>
{
"InstanceId": "cdwch-l9hnzxps",
"PageNumber": 1,
"PageSize": 10
}
输出示例
{
"Response": {
"EventTasks": [
{
"CreateTime": "2025-09-05T10:52:31+08:00",
"EventCode": "EmptyPassword",
"EventDetail": "检测到该实例存在安全隐患,创建集群时的默认 default 账户使用了空密码或弱密码,建议您及时对 default 账户密码进行增强,以提升安全防护能力。您可以通过 TCHouse-C 控制台>参数配置>XML模式>user.xml 对 default 密码进行更换。",
"EventNameDescribe": "default账户使用空密码",
"EventPriority": 3,
"EventTaskId": 5,
"FinishTime": "",
"HandleUser": "",
"IP": "",
"InstanceId": "",
"NeedAuthorization": 1,
"OperationType": [
"ModifyPassword"
],
"RepairId": "",
"Status": 1
},
{
"CreateTime": "2025-09-05T10:52:31+08:00",
"EventCode": "InstanceMaintenance",
"EventDetail": "检测到当前底层服务器因架构、软件升级等原因需要发起在线维护,以提升实例性能及安全性。为尽快修复异常,需要您授权我们进行后台处理,超过48小时未处理将认为您自动授权通过。",
"EventNameDescribe": "实例维护升级",
"EventPriority": 3,
"EventTaskId": 6,
"FinishTime": "",
"HandleUser": "100025004453",
"IP": "",
"InstanceId": "",
"NeedAuthorization": 2,
"OperationType": [
"OnlineMaintenanceForInstance",
"ShutdownForInstance"
],
"RepairId": "",
"Status": 3
},
{
"CreateTime": "2025-09-05T10:52:31+08:00",
"EventCode": "InstanceDiskAlter",
"EventDetail": "检测到节点当前底层服务器的本地硬盘存在坏盘隐患或使用寿命即将耗尽,可能导致实例 I/O 异常或磁盘掉线等数据层面异常。为尽快修复异常,需要您授权我们进行后台处理。",
"EventNameDescribe": "实例硬盘预警",
"EventPriority": 3,
"EventTaskId": 7,
"FinishTime": "",
"HandleUser": "100025004453",
"IP": "",
"InstanceId": "",
"NeedAuthorization": 2,
"OperationType": [
"OnlineMaintenanceForDisk",
"ShutdownForLocal",
"AbandonedDiskMigration"
],
"RepairId": "",
"Status": 3
},
{
"CreateTime": "2025-09-05T10:52:31+08:00",
"EventCode": "AbnormalInstanceDisk",
"EventDetail": "检测到当前底层服务器的本地硬盘突发故障,可能导致节点 I/O 性能降低或硬盘功能受损。为尽快修复异常,需要您授权我们进行后台处理,超过48小时未处理将认为您自动授权通过。",
"EventNameDescribe": "实例硬盘异常",
"EventPriority": 3,
"EventTaskId": 8,
"FinishTime": "",
"HandleUser": "100000951792",
"IP": "",
"InstanceId": "",
"NeedAuthorization": 2,
"OperationType": [
"ShutdownForLocal",
"AbandonedDiskMigration"
],
"RepairId": "",
"Status": 3
},
{
"CreateTime": "2025-09-05T10:52:31+08:00",
"EventCode": "InstanceRisk",
"EventDetail": "检测到当前底层服务器存在软硬件隐患,可能导致节点性能抖动或存在异常宕机风险。为尽快修复异常,需要您授权我们进行后台处理,超过48小时未处理将认为您自动授权通过。",
"EventNameDescribe": "实例运行隐患",
"EventPriority": 3,
"EventTaskId": 9,
"FinishTime": "",
"HandleUser": "100000951792",
"IP": "",
"InstanceId": "",
"NeedAuthorization": 2,
"OperationType": [
"ShutdownForLocal",
"AbandonedDiskMigration"
],
"RepairId": "",
"Status": 3
},
{
"CreateTime": "2025-09-05T10:52:31+08:00",
"EventCode": "InstanceRisk",
"EventDetail": "检测到当前底层服务器存在软硬件隐患,可能导致节点性能抖动或存在异常宕机风险。为尽快修复异常,需要您授权我们进行后台处理,超过48小时未处理将认为您自动授权通过。",
"EventNameDescribe": "实例运行隐患",
"EventPriority": 3,
"EventTaskId": 10,
"FinishTime": "",
"HandleUser": "100000951792",
"IP": "",
"InstanceId": "",
"NeedAuthorization": 2,
"OperationType": [
"ShutdownForSSD",
"OnlineMigrationForInstance"
],
"RepairId": "",
"Status": 3
}
],
"RequestId": "141981e2-81ec-4182-bf97-4f31a2735675",
"TotalCount": 6
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |