创建中断会话的任务

最近更新时间:2024-07-25 01:31:47

我的收藏

1. 接口描述

接口请求域名: dbbrain.tencentcloudapi.com 。

创建中断会话的任务。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateKillTask。
Version String 公共参数,本接口取值:2021-05-27。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String kill会话任务的关联实例ID。
示例值:cdb-test1
Duration Integer 任务持续时间,单位秒,手动关闭任务传-1。
示例值:10
Host String 任务过滤条件,客户端IP。
示例值:127.0.0.1
DB String 任务过滤条件,数据库库名,多个","隔开。
示例值:test,test1
Command String 任务过滤条件,相关命令,多个","隔开。
示例值:Time,Table Dump
Info String 任务过滤条件,支持单条件前缀匹配。
示例值:select
Infos.N Array of String 任务过滤条件,支持多个关键字匹配,与Info参数互斥。
示例值:where
User String 任务过滤条件,用户类型。
示例值:root
Time Integer 任务过滤条件,会话持续时长,单位秒。
示例值:10
Product String 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,默认为"mysql"。
示例值:mysql

3. 输出参数

参数名称 类型 描述
Status Integer kill会话任务创建成功返回1
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建中断会话的任务

输入示例

POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateKillTask
<公共请求参数>

{
    "InstanceId": "cdb-8jawylhf",
    "Product": "mysql",
    "Duration": -1
}

输出示例

{
    "Response": {
        "Status": 1,
        "RequestId": "09299b00-b878-11eb-b0b4-959ba47770cf"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
RequestLimitExceeded 请求的次数超过了频率限制。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。