KillMySqlThreads

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-09-14 10:32:28

Download PDF

1. API Description

Domain name for API request: dbbrain.tencentcloudapi.com.

This API is used to interrupt the current session according to the session ID. It needs to be called twice to commit the session interruption task in two stages. In the pre-commit stage, the stage value is Prepare, and the returned value is SqlExecId’. In the commit stage, the stage value is Commit, and SqlExecId` will be passed in as a parameter. Then the session process will be terminated.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dbbrain.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: KillMySqlThreads.
Version	Yes	String	Common parameter. The value used for this API: 2021-05-27.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID.
Stage	Yes	String	The stage of a session killing task. Valid values: Prepare (preparation stage), Commit (commit stage).
Threads.N	No	Array of Integer	The ID list of MySQL sessions to be killed. This parameter is used in the “Prepare” stage.
SqlExecId	No	String	Execution ID. This parameter is used in the “Commit” stage.
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
Threads	Array of Integer	The ID list of MySQL sessions that have been killed.
SqlExecId	String	Execution ID, which is output in the “Prepare” stage and used to specify the ID of the session to be killed in the “Commit” stage. Note: this field may return `null`, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Interrupting the current session according to session ID

This example shows you how to interrupt the current session according to the session ID in the “commit” stage.

Input Example

POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: KillMySqlThreads
<Common request parameters>

{
    "InstanceId": "cdb-8jawylhf",
    "SqlExecId": "2e2e2",
    "Stage": "Commit",
    "Product": "mysql"
}

Output Example

{
  "Response": {
    "SqlExecId": "xx",
    "Threads": [
      0
    ],
    "RequestId": "xx"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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.

Recent Pages