tencent cloud

文档反馈

ModifyCDBProxyConnectionPool

最后更新时间:2023-06-21 10:02:42
This document is currently invalid. Please refer to the documentation page of the product.

    1. API Description

    This API will be disused soon.

    Planned disuse time: 2023-07-17 19:48:54

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

    This API has been deprecated and replaced with AdjustCdbProxyAddress.

    This API is used to configure the connection pool of database proxy. The supported configurations can be obtained by the DescribeProxyConnectionPoolConf API.

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

    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: ModifyCDBProxyConnectionPool.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region No String Common Params. This parameter is not required for this API.
    ProxyGroupId Yes String Database proxy ID
    OpenConnectionPool Yes Boolean Whether to enable the connection pool. Valid values: true (enable);
    false (disable).
    ConnectionPoolType No String Connection pool type.
    You can use the DescribeProxyConnectionPoolConf API to query the connection pool type.
    PoolConnectionTimeOut No Integer Connection persistence timeout in seconds

    3. Output Parameters

    Parameter Name Type Description
    AsyncRequestId String Async request ID
    Note: this field may return null, indicating that no valid value can be found.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Configuring the connection pool of database proxy

    Input Example

    POST / HTTP/1.1
    Host: cdb.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyCDBProxyConnectionPool
    <Common request parameters>
    
    {
        "OpenConnectionPool": true,
        "ConnectionPoolType": "SessionConnectionPool",
        "PoolConnectionTimeOut": 10,
        "ProxyGroupId": "proxy-test"
    }
    

    Output Example

    {
        "Response": {
            "AsyncRequestId": "8155d27a-079a2580-19593e48-f1af5042",
            "RequestId": "3689c0eb-a92d-77ce-0ee2-17d99f604e64"
        }
    }
    

    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
    InternalError.HttpError Exceptional HTTP request
    InternalError.UnknownError Unknown error