tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeProxySessionKillTasks

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

    1. API Description

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

    This API is used to query the result of the session killing task executed by the Redis proxy node. The async task ID (an input parameter) is obtained after the API CreateProxySessionKillTask is successfully called. Currently, the only valid value of product is redis.

    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: DescribeProxySessionKillTasks.
    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.
    AsyncRequestIds.N Yes Array of Integer The async session killing task ID, which is obtained after the API CreateProxySessionKillTask is successfully called.
    Product Yes String Service type. Valid value: redis (TencentDB for Redis).

    3. Output Parameters

    Parameter Name Type Description
    Tasks Array of TaskInfo Session killing task details.
    TotalCount Integer Total number of tasks.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the execution result of the session killing task

    Input Example

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

{
    "InstanceId": "xx",
    "Product": "xx",
    "AsyncRequestIds": [
        0
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "xx",
        "TotalCount": 1,
        "Tasks": [
            {
                "Progress": 100,
                "InstProxyList": [
                    "6511ec503b047be913e30c1bbf1f2c8c861e8347",
                    "2ce994dadc0e2b27e76ae13d04ab9eadd9665397",
                    "db0fcd29867e65eb999ce99383d7a06cd21ca077"
                ],
                "AsyncRequestId": 7677678,
                "EndTime": "2020-09-22T00:00:00+00:00",
                "InstProxyCount": 3,
                "InstanceId": "crs-o5chheqz",
                "CreateTime": "2020-09-22T00:00:00+00:00",
                "StartTime": "2020-09-22T00:00:00+00:00",
                "TaskStatus": "finished",
                "FinishedProxyList": [
                    "6511ec503b047be913e30c1bbf1f2c8c861e8347",
                    "2ce994dadc0e2b27e76ae13d04ab9eadd9665397",
                    "db0fcd29867e65eb999ce99383d7a06cd21ca077"
                ],
                "FailedProxyList": []
            }
        ]
    }
}

    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.
    DryRunOperation DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful.
    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.
    ResourceInUse The resource is occupied.
    ResourceInsufficient Insufficient resource.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable The resource is unavailable.
    ResourcesSoldOut The resources have been sold out.
    UnauthorizedOperation The operation is unauthorized.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy