tencent cloud



Last updated: 2022-07-08 10:18:41

1. API Description

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

This API is used to add a read-only replica to an RO group.

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: AddDBInstanceToReadOnlyGroup.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DBInstanceId Yes String Instance ID
ReadOnlyGroupId Yes String RO group ID

3. Output Parameters

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

4. Example

Example1 Adding instance "postgres-k95qzetn" to RO group "pgrogrp-test"

Input Example

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

    "ReadOnlyGroupId": "\"pgrogrp-test\"",
    "DBInstanceId": "\"postgres-k95qzetn\""

Output Example

  "Response": {
    "RequestId": "d43b2a9f-070c-480b-a0bb-7c210428cfe8",
    "FlowId": 912

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.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.FailedOperationError Operation failed. Please try again later.
FailedOperation.FlowCreateError Failed to create a task. Please try again later. If the problem persists, please contact customer service.
FailedOperation.ROGroupMasterInstanceNotRight The primary instance information of the RO group is not matched.
FailedOperation.ROGroupNotFoundError The RO group does not exist.
FailedOperation.ROInstanceHasInROGroupError This read-only replica already belongs to another RO group.
InstanceNotExist The current instance does not exist.
InternalError.DBError Backend database execution 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.InvalidReadOnlyGroupStatus RO group in incorrect status
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
InvalidParameterValue.ReadOnlyGroupNotExist The RO group does not exist.
OperationDenied.CamDeniedError This operation cannot be performed.
OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
OperationDenied.ROGroupStatusError This operation cannot be performed on an RO group in this status.
OperationDenied.ROInstanceStatusLimitOpError This operation cannot be performed on a read-only instance in this status.
OperationDenied.RoInstanceCountExeedError The total number of read-only nodes should not exceed the upper limit.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
ResourceUnavailable.InvalidInstanceStatus Incorrect instance status.
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