- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Operation Guide
- Best Practices
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Health Report Email Sending APIs
- Exception Detection APIs
- Session Killing APIs
- Space Analysis APIs
- Slow Log Analysis APIs
- Security Audit APIs
- Database Audit APIs
- Other APIs
- Data Types
- Error Codes
- DBbrain APIs 2019-10-16
- FAQs
- Service Level Agreement
- Glossary
- Contact Us
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Operation Guide
- Best Practices
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Health Report Email Sending APIs
- Exception Detection APIs
- Session Killing APIs
- Space Analysis APIs
- Slow Log Analysis APIs
- Security Audit APIs
- Database Audit APIs
- Other APIs
- Data Types
- Error Codes
- DBbrain APIs 2019-10-16
- FAQs
- Service Level Agreement
- Glossary
- Contact Us
1. API Description
Domain name for API request: dbbrain.tencentcloudapi.com.
This API is used to create a session killing task.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateKillTask. |
| Version | Yes | String | Common Params. The value used for this API: 2021-05-27. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| InstanceId | Yes | String | ID of the instance associated with the session killing task. |
| Duration | Yes | Integer | Task duration in seconds. Pass in -1 to stop the task manually. |
| Host | No | String | Client IP, which is a task filter. |
| DB | No | String | Database name, which is a task filter. Multiple database names are separated by comma. |
| Command | No | String | Related command, which is a task filter. Multiple commands are separated by comma. |
| Info | No | String | Task filter. Filtering by single filter prefix is supported. |
| User | No | String | User type, which is a task filter. |
| Time | No | Integer | Session duration in seconds, which is a task filter. |
| Product | No | String | Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Status | Integer | Task status. 1 is returned if the session killing task is successfully created. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Creating a session killing task
Input Example
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateKillTask
<Common request parameters>
{
"InstanceId": "cdb-8jawylhf",
"Product": "mysql",
"Duration": -1
}
Output Example
{
"Response": {
"Status": 1,
"RequestId": "09299b00-b878-11eb-b0b4-959ba47770cf"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | Error with CAM signature/authentication. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.UserHasNoStrategy | Error with CAM authentication. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| UnauthorizedOperation | The operation is unauthorized. |
| UnknownParameter | Unknown parameter. |
| UnsupportedOperation | Unsupported operation. |
Yes
No
Was this page helpful?