tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for PostgreSQLRead-only Replica APIsRebalanceReadOnlyGroup
RebalanceReadOnlyGroup
Last updated: 2024-06-17 14:25:52
RebalanceReadOnlyGroup
Last updated: 2024-06-17 14:25:52

1. API Description

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

This API is used to rebalance the loads of read-only replicas in an RO group. Please note that connections to those read-only replicas 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.

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: RebalanceReadOnlyGroup.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
ReadOnlyGroupId Yes String RO group ID

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Rebalancing the traffic load of read-only instances in RO group

Input Example

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

{
    "ReadOnlyGroupId": "\"pgrogrp-e0tfm161\""
}

Output Example

{
    "Response": {
        "RequestId": "d43b2a9f-070c-480b-a0bb-7c210428cfe8"
    }
}

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
FailedOperation.BaseNetworkAccessError Failed to access classic network. Please try again later. If the problem persists, please contact customer service.
FailedOperation.CamAuthFailed CAM authentication failed.
FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.DeleteAllRoute Failed to delete VPC routes.
FailedOperation.FailedOperationError Operation failed. Please try again later.
FailedOperation.ROGroupNotFoundError The RO group does not exist.
FailedOperation.VPCResetServiceError Failed to configure the VPC.
FailedOperation.VPCUpdateRouteError Failed to update VPC routes.
InterfaceNameNotFound ACTION input error.
InternalError.InternalHttpServerError An exception occurred while executing the request.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
OperationDenied.CamDeniedError This operation cannot be performed.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
VpcError VPC error
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon