ModifyRoType

Last updated: 2021-04-15 16:40:36

1. API Description

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

This API is used to change a general RO replica to delayed RO replica.

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: cdb.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: ModifyRoType.
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.
InstanceId Yes String Instance ID
SrcRoInstType Yes String The original type of an RO replica. Valid values: NORMAL (do not support delayed replication), DELAY_REPLICATION (support delayed replication).
DstRoInstType Yes String The target type of an RO replica. Valid values: NORMAL (do not support delayed replication), DELAY_REPLICATION (support delayed replication).
ReplicationDelay No Integer Replication delay in seconds. This parameter is required when a regular RO replica is switched to a delayed one. Value range: 1 to 259200.

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 Changing the type of a read-only replica

This example shows you how to change the type of an RO replica.

Input Example

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

{
    "InstanceId": "cdbro-test",
    "SrcRoInstType": "NORMAL",
    "DstRoInstType": "DELAY_REPLICATION",
    "ReplicationDelay": 259200
}

Output Example

{
  "Response": {
    "RequestId": "28a67cf3-4589-8534-2be0-17475fa5c892"
  }
}

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.NotDelayRo The instance is not a delayed RO replica.
FailedOperation.OperationReplicationError Failed to call the backend API to enable delayed replication.
InternalError An internal error occurred.
InvalidParameterValue.DueTimeWrong The specified point in time should not be later than the current time.
InvalidParameterValue.SrcTypeEqualDstType The original type should not be the same as the target type.
InvalidParameterValue.SrcTypeNotEqualDstType The RO replica is not the type of instance allowed by the operation.
OperationDenied.DelayReplicationRunning The operation is not allowed during the delayed replication.
OperationDenied.InstanceTaskRunning Delayed replication is not allowed because the instance is executing another task.

Was this page helpful?

Was this page helpful?

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