tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateProxySessionKillTask

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

    1. API Description

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

    This API is used to create an async task of killing all proxy node connection sessions and is currently supported only for Redis. The async task ID is the returned value, which can be passed to the API DescribeProxySessionKillTasks as a parameter to query the execution status of the 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: CreateProxySessionKillTask.
    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.
    Product Yes String Service type. Valid value: redis (TencentDB for Redis).

    3. Output Parameters

    Parameter Name Type Description
    AsyncRequestId Integer Async task ID that is returned after the session killing task is created.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating an async task of killing all proxy node connection sessions based on instance ID

    Input Example

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

{
    "InstanceId": "cdb-8jawylhf",
    "Product": "redis"
}

    Output Example

    {
    "Response": {
        "AsyncRequestId": 123456,
        "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

    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
    FailedOperation Operation failed.
    OperationDenied.UserHasNoStrategy Error with CAM authentication.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy