tencent cloud



Last updated: 2022-08-17 15:58:26

1. API Description

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

This API is used to configure the connection pool of database proxy. You can use the DescribeProxyConnectionPoolConf API to query the supported connection pool configurations.

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: ModifyCDBProxyConnectionPool.
Version Yes String Common Params. The value used for this API: 2017-03-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
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

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


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
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support