tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

KillMySqlThreads

Last updated: 2023-10-17 10:51:54

    1. API Description

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

    This API is used to interrupt the current session by 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.

    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: KillMySqlThreads.
    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 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 List of IDs of the 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.
    RecordHistory No Boolean Whether to record the thread killing history. The default value is true, indicating “yes”. You can set it to false (“no”) to speed up the killing process.

    3. Output Parameters

    Parameter Name Type Description
    Threads Array of Integer List of IDs of the 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 Killing the current session by session ID

    This example shows you how to interrupt the current session by 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": "ewfscd",
        "Threads": [
            0
        ],
        "RequestId": "sscrft"
    }
}

    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

    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.
    LimitExceeded The quota limit is exceeded.
    MissingParameter Missing parameter.
    OperationDenied Operation denied.
    OperationDenied.UserHasNoStrategy Error with CAM authentication.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation The operation is unauthorized.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy