Help & DocumentationAPIsTencentDB for MySQLInstance APIsBalanceRoGroupLoad

BalanceRoGroupLoad

Last updated: 2020-03-23 14:59:30

1. API Description

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

This API is used to rebalance the loads of instances in an RO group. Please note that the database connections to those instances will be interrupted transiently; therefore, you should ensure that your application can reconnect to the databases. This operation should be performed with caution.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: BalanceRoGroupLoad.
Version Yes String Common parameter. The value used for this API: 2017-03-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
RoGroupId Yes String RO group ID in the format of cdbrg-c1nl9rpv.

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 Rebalancing the loads of instances in RO group

Input Example

https://cdb.tencentcloudapi.com/?Action=BalanceRoGroupLoad
&RoGroupId=cdbrg-eb2w7dto
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.StatusConflict Task status conflict.
InternalError.DatabaseAccessError Internal database error.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.