Updates the replication channel of a native replication instance.
Operation description
Supported engine
RDS MySQL
Related documentation
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. |
cn-hangzhou |
| DbInstanceId |
string |
Yes |
The ID of the instance. |
rm-bp1234567890abcdef |
| ChannelName |
string |
No |
The name of the replication channel. |
replication-channel-001 |
| MasterHost |
string |
No |
The host address of the master database. You can specify an IP address or a domain name. |
192.168.1.100 |
| MasterPort |
integer |
No |
The port number of the master database. The typical port for MySQL is 3306. |
3306 |
| MasterUser |
string |
No |
The username for the replication user on the master database. Specify this parameter only if you need to update it. |
repl_user |
| MasterPassword |
string |
No |
The password for the replication user on the master database. The password must be Base64-encoded. |
U2VjdXJlUGFzczEyMyE= |
| Operation |
string |
Yes |
The operation to perform on the replication channel. |
Start |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response object. |
||
| RequestId |
string |
The request ID. |
17F57FEE-EA4F-4337-8D2E-9C23CAA63D74 |
Examples
Success response
JSON format
{
"RequestId": "17F57FEE-EA4F-4337-8D2E-9C23CAA63D74"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidReplicationChannelName.Forbid | Specified replication channel name is forbidden (reserved for internal use). | Specified replication channel name is forbidden (reserved for internal use). |
| 400 | InvalidReplicationChannel.Duplicate | Specified replication channel already exists. | Specified replication channel already exists. |
| 400 | MissingReplicationParam | Missing required parameters for replication operation: MasterHost, MasterPort, MasterUser, MasterPassword. | Missing necessary replication-related parameters |
| 400 | MissingOperationParam | Missing required parameter: Operation. | Missing required parameter: Operation. |
| 400 | InvalidOperation.NotSupport | Specified operation is not supported. Supported operations: Stop, Start, Restart, Rebuild. | Specified operation is not supported. Supported operations: Stop, Start, Restart, Rebuild. |
| 400 | InvalidMasterPort.Format | Specified MasterPort format is not valid. | Specified MasterPort format is not valid. |
| 400 | MissingRebuildParam | Missing required parameters for rebuild operation: MasterHost, MasterPort, MasterUser, MasterPassword. | Missing required parameters for rebuild operation: MasterHost, MasterPort, MasterUser, MasterPassword. |
| 404 | InvalidReplicationChannel.NotFound | Specified replication channel does not exist. | Specified replication channel does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.