tencent cloud



Last updated: 2022-08-17 15:58:26
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to configure read/write separation of database proxy.

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: ModifyCDBProxy.
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 Unique ID of the database proxy group
IsKickout No Boolean Whether to remove delayed read-only instances from the proxy group. Valid values: true, false. Default value: false.
MinCount No Integer The minimum number of read-only instances allowed by the proxy group. Minimum value: 1; maximum value: The number of instances.
MaxDelay No Integer Delay threshold. If IsKickOut is set to true, this parameter is required.
WeightMode No String Assignment mode of read/write weights. Valid values: system (auto-assigned), custom
RoWeightValues No RoWeight Read-Only weight of an instance
FailOver No Boolean Whether to enable failover. If it is enabled, the connection address will route requests to the source instance in case of proxy failure. Valid values: true, false. Default value: false.
AutoAddRo No Boolean Whether to automatically add newly created read-only instances to the proxy group. Valid values: true, false Default value: false.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Configuring read/write separation of database proxy

Input Example

Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCDBProxy
<Common request parameters>

    "RoWeightValues": {},
    "MaxDelay": 1,
    "AutoAddRo": true,
    "ProxyGroupId": "proxy-test",
    "IsKickout": true,
    "FailOver": true,
    "MinCount": 1,
    "WeightMode": "system"

Output Example

    "Response": {
        "RequestId": "122198-2222-1223-2222-c3a1733"

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
FailedOperation.ProxyGroupStatusError Database proxy in an exceptional status.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value
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