1. 接口描述
接口请求域名： dbbrain.api3.fincloud.tencent.com。
根据会话ID中断当前会话，该接口分为两次提交：第一次为预提交阶段，Stage为"Prepare"，得到的返回值包含SqlExecId；第二次为确认提交， Stage为"Commit"， 将SqlExecId的值作为参数传入，最终终止会话进程。
默认接口请求频率限制：20次/秒。
接口更新时间：2025-05-20 11:46:18。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：KillMySqlThreads |
| Version | 是 | 否 | String | 公共参数，本接口取值：2021-05-27 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| RecordHistory | 否 | 是 | Bool | 默认是true，会记录下kill的记录；该参数为true, 则在kill操作前校验目标会话是否存在，存在则继续kill，否则取消kill。为了加快kill速度，可设置为false。 示例值： false |
| InstanceId | 是 | 否 | String | 实例ID。 示例值： shard-lm6o3jwi |
| Stage | 是 | 否 | String | kill会话任务的阶段，取值包括："Prepare"-准备阶段，"Commit"-提交阶段。 示例值： Commit |
| Threads | 否 | 是 | Array of Int64 | 需要 kill 的 sql 会话 ID 列表，当 Prepare 阶段，此参数必传，当 Commit 阶段，不需要传递。 示例值： ["4714056"] |
| SqlExecId | 否 | 是 | String | 执行ID，此参数用于Commit阶段。 示例值： ItNrO0i3lvE3 |
| Product | 是 | 否 | String | 服务产品类型，支持值包括： "mariadb" - 数据库 MariaDB， "dcdb" - 数据库 TDSQL MySQL，默认为"mariadb"。 示例值： mariadb |
| ClusterId | 否 | 是 | String | 集群 ID。 示例值： tdsqlshard-70m8bedq |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Threads | Array of Int64 | kill完成的sql会话ID列表。 示例值： [536284] |
| SqlExecId | String | 执行ID， Prepare阶段的任务输出，用于Commit阶段中指定执行kill操作的会话ID。 示例值： "AEnnKexGijsX" |
| Schema | String | "" 示例值： "" |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InvalidParameter | |
| UnauthorizedOperation | |
| UnsupportedOperation | |
| MissingParameter | |
| AuthFailure | |
| InternalError | |
| RequestLimitExceeded | |
| LimitExceeded | |
| ResourceNotFound | |
| OperationDenied | |
| FailedOperation | |
| UnknownParameter | |
| OperationDenied.UserHasNoStrategy |