Creates a replication link for a native replication instance.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The ID of the region where the instance resides. |
cn-hangzhou |
| DbInstanceId |
string |
Yes |
The instance ID. You can call the |
rm-bp1234567890abcdef |
| ChannelName |
string |
No |
The name of the replication channel. This name identifies the replication link and must be unique for the instance. |
replication-channel-001 |
| MasterHost |
string |
Yes |
The endpoint of the master database. This can be an IP address or a domain name. |
192.168.1.100 |
| MasterPort |
integer |
Yes |
The port number used to connect to the master database. For MySQL, the port is typically 3306. |
3306 |
| MasterUser |
string |
Yes |
The username for the replication account on the master database. |
repl_user |
| MasterPassword |
string |
Yes |
The password for the replication account on the master database. The value of this parameter must be Base64-encoded. |
U2VjdXJlUGFzczEyMyE= |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned data. |
||
| RequestId |
string |
The ID of the request. |
76364A52-E0AB-5CC8-9818-CF1DC482C092 |
Examples
Success response
JSON format
{
"RequestId": "76364A52-E0AB-5CC8-9818-CF1DC482C092"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidReplicationChannel.Duplicate | Specified replication channel already exists. | Specified replication channel already exists. |
| 400 | InvalidReplicationChannelName.Forbid | Specified replication channel name is forbidden (reserved for internal use). | Specified replication channel name is forbidden (reserved for internal use). |
| 400 | MissingReplicationParam | Missing required parameters for replication operation: MasterHost, MasterPort, MasterUser, MasterPassword. | Missing necessary replication-related parameters |
| 400 | InvalidMasterPort.Format | Specified MasterPort format is not valid. | Specified MasterPort format is not valid. |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | This operation is not supported for the database engine of the instance. |
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | The operation failed. The RDS instance is not in a ready state. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.