ModifyDBInstanceReadOnlyGroup

Last updated: 2021-03-01 17:01:00

1. API Description

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

This API is used to modify the RO group of an instance.

A maximum of 20 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: postgres.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ModifyDBInstanceReadOnlyGroup.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
DBInstanceId Yes String Instance ID
ReadOnlyGroupId Yes String ID of the RO group to which the read-only replica belongs
NewReadOnlyGroupId Yes String ID of the new RO group into which the read-only replica will move

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 ModifyDBInstanceReadOnlyGroup

Input Example

https://postgres.tencentcloudapi.com/?Action=ModifyDBInstanceReadOnlyGroup
&DBInstanceId="postgres-k95qzetn"
&NewReadOnlyGroupId=NewGroup
&ReadOnlyGroupId=OldGroup
&<Common request parameters>

Output Example

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

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.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.IllegalROInstanceNum Invalid number of read-only replicas.
FailedOperation.ROGroupNotFoundError The RO group does not exist.
InstanceNotExist The current instance does not exist.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InvalidInstanceStatus Incorrect instance status.
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.ROGroupStatusError This operation cannot be performed on an RO group 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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help