1. 接口描述
接口请求域名: dbbrain.tencentcloudapi.com 。
根据会话ID中断当前会话,该接口分为两次提交:第一次为预提交阶段,Stage为"Prepare",得到的返回值包含SqlExecId;第二次为确认提交, Stage为"Commit", 将SqlExecId的值作为参数传入,最终终止会话进程。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:KillMySqlThreads。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-27。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID。 示例值:cdb-test1 |
Stage | 是 | String | kill会话任务的阶段,取值包括:"Prepare"-准备阶段,"Commit"-提交阶段。 示例值:Commit |
Threads.N | 否 | Array of Integer | 需要kill的sql会话ID列表,此参数用于Prepare阶段。 示例值:["4714056"] |
SqlExecId | 否 | String | 执行ID,此参数用于Commit阶段。 示例值:ItNrO0i3lvE3 |
Product | 否 | String | 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。 示例值:mysql |
RecordHistory | 否 | Boolean | 默认是ture, 记录下kill的记录,为了加快kill,可设置为false。 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Threads | Array of Integer | kill完成的sql会话ID列表。 示例值:[536284] |
SqlExecId | String | 执行ID, Prepare阶段的任务输出,用于Commit阶段中指定执行kill操作的会话ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:"AEnnKexGijsX" |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据会话ID中断当前会话
Stage为"commit"阶段
输入示例
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: KillMySqlThreads
<公共请求参数>
{
"InstanceId": "cdb-8jawylhf",
"SqlExecId": "2e2e2",
"Stage": "Commit",
"Product": "mysql"
}
输出示例
{
"Response": {
"SqlExecId": "ewfscd",
"Threads": [
0
],
"RequestId": "sscrft"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |