tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for MySQLInstance APIsStopReplication
StopReplication
Last updated: 2024-11-20 11:14:48
StopReplication
Last updated: 2024-11-20 11:14:48

1. API Description

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

This API is used to stop the data replication from the source instance to the read-only instance.

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: StopReplication.
Version Yes String Common Params. The value used for this API: 2017-03-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Read-Only instance ID.

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async task ID.
Note: this field may return null, indicating that no valid values can be obtained.
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 Stopping the data replication to a read-only instance

Input Example

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

{
    "InstanceId": "cdb-test"
}

Output Example

{
    "Response": {
        "RequestId": "xx",
        "AsyncRequestId": "xx"
    }
}

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 Operation failed.
FailedOperation.NotDelayRo It is not a read-only instance with delayed replication enabled.
InternalError An internal error occurred.
InternalError.DBError Database exception
InternalError.UnknownError Unknown error
OperationDenied.InstanceTaskRunning Delayed replication is not allowed because the instance is executing another task.
ResourceNotFound.InstanceNotFundError The instance does not exist.
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 avaliable.

Submit a Ticket
7x24 Phone Support