Replicates databases from one instance to another.
Operation Description
You can also call this operation to restore specific databases to an existing instance by point in time or backup set. For more information, see Restore the data of an ApsaraDB RDS for SQL Server instance.
Before you call this operation, make sure that the following requirements are met:
- The source and destination instances belong to the same account.
- The source and destination instances run the same version of database engine.
- The source and destination instances reside in the same region and use the same network type. The instances can reside in different zones.
- The source and destination instances do not have databases whose names are the same.
- The available storage of the destination instance is larger than the total size of the databases that you want to replicate from the source instance.
NoteThis operation is supported only for instances that run SQL Server 2012 and later.
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| rds:CopyDatabaseBetweenInstances | WRITE |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The ID of the source instance. | rm-uf6wjk5xxxxxxx |
| TargetDBInstanceId | string | Yes | The ID of the destination instance, which must differ from the ID of the source instance. | rm-ut5ajk3xxxxxxx |
| DbNames | string | Yes | The names of the databases. Format: | {"test1":"newtest1","test2":"newtest2"} |
| BackupId | string | No | The ID of the backup set by which you want to restore databases of the source instance. You can call the DescribeBackups operation to obtain the ID of the backup set. NoteYou must specify one of BackupId and RestoreTime. | 106523874**** |
| RestoreTime | string | No | The point in time when the system replicates databases. You can select a point in time within the backup retention period. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. NoteYou must specify one of BackupId and RestoreTime. | 2011-06-11T16:00:00Z |
| SyncUserPrivilege | string | No | Specifies whether to copy users and permissions.
Default value: NO. | NO |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "803D11AF-C370-465B-AB46-CB3A642DC303"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidBackupSetID | Invalid backup set id. | The backup set does not exist. You can call the DescribeBackups operation to query existing backup sets. |
| 400 | DBCountLimitExceeded | Db count limit exceeded. | The number of databases is exceeded. |
| 400 | BackupRestoreNotSupported.BasicHA | Basic instances cannot be restored to high availability instances, and high availability instances cannot be restored to basic instances. | You cannot restore data from an RDS instance in the Basic Edition to an RDS instance in the High-availability Edition and vice versa. |
| 400 | BackupRestoreNotSupported.HADedicatedAlwaysOn | High availability instances cannot be restored to dedicated cluster instances or AlwaysOn instances. | The operation failed. The data of an RDS instance that runs the RDS High-availability Edition cannot be restored to an RDS instance that is deployed in a dedicated cluster or runs the RDS Enterprise Edition. |
| 400 | BackupRestoreNotSupported.ShareDedicatedAlwaysOn | Shared instances cannot be restored to dedicated cluster instances, AlwaysOn instances, or high availability instances. | - |
| 400 | OperationDenied.RestoreTime | The instance with snapshot backup enabled can only be restored to the instance with snapshot backup enabled. | You can only restore to snapshot backup-enabled instances for instances that have enabled snapshot backup. |
| 400 | OperationDenied.SnapshotBackupSet | Snapshot backup set can only be restored to the instance with snapshot backup enabled. | You can only restore to snapshot backup-enabled instances for instances that have enabled snapshot backup and whose backup set type is snapshot. |
| 400 | CanNotCopyDBHasTDEEnabled | The source database has enabled the TDE feature. You cannot copy it to another instance. | TDE is enabled for the source RDS instance. Therefore, the data of the source RDS instance cannot be replicated to a different RDS instance. |
| 400 | InvalidBackupDBNames.NotFound | The specified BackupDBNames is not found. | The operation failed. The instance name is not specified. |
| 400 | InvalidBackupDBNames.Malformed | The specified backup database is not valid. | The operation failed. The database name is invalid. |
| 400 | InvalidDBName.Format | Specified DB name is not valid. | The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit. |
| 400 | InvalidDBInstanceName.NotFound | Invalid DBInstanceId NotFound. | The instance ID cannot be found. |
| 400 | EngineNotSupported | The engine does not support the operation. | The operation is not supported for the database engine that is run on the RDS instance. |
| 400 | InvalidTargetDBInstanceName.Format | Specified Target DB instance name is not valid. | The name of the destination instance is invalid. |
| 400 | MasterDBInstanceState.NotSupport | The Master instance state does not support this operation. | The operation failed. The RDS instance is not in a ready state. |
| 400 | TargetInstanceEngineNotSupported | The specified Engine cannot be supported the operation. | The engine does not support the operation. |
| 400 | InvalidInstancesRegion.Malformed | The instance region is not the same as the target instance region. | The destination instance resides in a different region from the source instance. |
| 400 | InvalidStartTime.Format | The specified parameter "StartTime" is not valid. | The start time is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. For example, you can set the start time to 2012-06-11T15:00Z in the DescribeDBInstancePerformance operation and set the start time to 2011-06-11T16:00Z in the DescribeErrorLogs operation. |
| 400 | InvalidEndTime.Format | The specified parameter "EndTime" is not valid. | The operation failed. The end time is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2012-06-11T15:00Z. |
| 400 | InvalidParameterCombination | The end time must be greater than the start time | The end time must be later than the start time. |
| 400 | InvalidBackupSetLocation.Format | Specified backup set location is not valid. | - |
| 400 | InvalidCrossRegionTrans | Cross region instance trans is not supported | - |
| 400 | ErrorParametersConflict | Parameter BackupsetID and restoretime can only exist one. | - |
| 400 | InvalidDBName.NotFound | Specified DB name does not exist. | The database name cannot be found. Enter a valid database name. |
| 400 | InvalidDBName.Duplicate | Specified DB name already exists in the This instance. | A database with the same name has been created on the RDS instance. Specify a different name. |
| 400 | ReadDBInstanceNotSupport | The operation is not permitted due to type of the instance. | - |
| 400 | InvalidRecoveryDbInstance.StorageSize | The disk space of the new instance cannot be less than that of the current instance | The operation failed. The available storage space of the new RDS instance must be greater than or equal to the total size of data stored in the original RDS instance. |
| 400 | InvalidRecoveryDBNames.Format | The specified parameter DBNames is not valid. | The instance name is invalid. Check the instance name. |
| 400 | InvalidBackupIdOrRestoreTime.NotFound | The specified parameter BackupId or RestoreTime is not valid. | The operation failed. The values of the BackupId and RestoreTime parameters are invalid. |
| 400 | Forbidden.RegionNotFound | The provided RegionId does not exist in our record. | The operation failed. The region ID cannot be found. |
| 400 | ImageNotFound | The specified Image is disabled or is deleted. | - |
| 400 | InvalidZone.NotSupportedForStorageType | The specified zone is closed or invalid for Specified DBInstanceStorageType. | - |
| 400 | InvalidEngineOrEngineVersion | The specified params engine or engineVersion should not be null. | - |
| 400 | InvalidGeneralGroupNameOrGdnInstanceName | The specified params generalGroupName or gdnInstanceName should not be null. | - |
| 400 | InvalidVSwitchId.NotFound | Specified virtual switch is not found in specified VPC. | No vSwitch is available in the VPC. |
| 400 | CDDC.TargetHostIDNotAvailable | The target host ID is not available. | The host is unavailable. Specify a different host. |
| 400 | CDDC.AvailableHostsNotEnoughInZone | Not enough available hosts are in the target zone. | - |
| 400 | ReadOnlyInstanceNotSupport | Specified ReadOnly Instance not support this operation. | Read-only instances do not support the operation. |
| 400 | InvalidShareDbInstanceClassNotSupport | The current instance classType is not support operation. | This operation is not supported for the specified instance type. |
| 400 | InvalidQuantity.NotSupported | The specified instance quantity is not supported. | The number of RDS instances exceeds the upper limit. Check the number of RDS instances. |
| 400 | IncorrectMasterDBInstanceState | Master instance state does not support this operation. | - |
| 400 | InvalidDBInstance.ReadDBInstanceExceeded | Current DB Instance exceeding the allowed amount of read instance. | The number of read-only instances exceeds the upper limit. Adjust the number of read-only instances. A primary ApsaraDB RDS for MySQL instance with more than 64 GB memory supports a maximum of 10 read-only instances. An ApsaraDB RDS for MySQL with less than 64 GB memory supports a maximum of five read-only instances. |
| 400 | InvalidEngineVersion.Malformed | Specified engine version is not valid. | The database engine version is invalid. Check the database engine version and try again. |
| 400 | InvalidEssdStorageSize | The cloud ESSD storage size is invalid. | The storage size of cloud disks is invalid. Check the storage size. |
| 400 | IncorrectInstanceNetworkType | The specified parameter InstanceNetworkType is not valid. | - |
| 400 | AtLeastTwoVSwitchParamExists | The specified params(Vswitchs) at least two. | At least two Vswitchs parameters must be specified. Each Vswitchs parameter specifies a vSwitch in a zone. |
| 400 | InvalidIzNo.NotSupported | Specified VPC zone is not supported. | The zone of the VPC differs from the zone of the RDS instance. |
| 403 | StorageLimitExceeded | Exceeding the allowed Storage of DB instance. | The disk usage exceeds the upper limit. Free your disk space. |
| 403 | InvalidTempInstance.NotSupport | The temp db Instance is not support. | The instance is locked. |
| 403 | IncorrectDBInstanceState | The current database instance state does not support the operation. | The operation failed. The RDS instance is not running. |
| 403 | IncorrectDBInstanceType | Current DB instance engine and type does not support operations. | The operation failed. The operation is not supported for the database engine of the RDS instance. |
| 403 | Forbidden.SnapshotRecovery | Snapshot backup does not support partial restore | The operation failed. Snapshot backup files cannot be used to restore only a specific part of data. |
| 403 | OperationDenied.Resource | Specified DB instance class or storage is not available in all Availability Zones. | Insufficient resources. Try again with a different instance type or storage size. |
| 403 | ReadonlyDBInstanceStorageExceeded | You can not create the order with the db instance because The masterInstance storage value exceeding the readonlyInstance storage value. | The primary instance storage value exceeds the read-only instance storage value. You cannot use the database instance to create an order. |
| 403 | MasterDBInstanceClassNotSupport | You can not create the readonly instance with the master instance class does not support. | The operation failed. The current primary instance class does not support creating read-only instances. |
| 403 | ReadonlyDBInstanceClassNotSupport | You can not create the readonly instance with the instance class does not support. | The operation failed. The current instance class does not support creating read-only instances. |
| 403 | ReadonlyDBInstanceClassLowerThanMasterInstance | The readonly instance db instance class are lower than master instance db instance class. | The read-only instance has lower specifications than the primary instance. |
| 403 | InvalidSwitchType.Malformed | The specified parameter InvalidSwitchType is not valid. | The value of the InvalidSwitchType parameter is invalid. |
| 403 | UnsupportedCopyDbHighAvailabilityToBasic | Replicate Database from RDS Category:HighAvailability to RDS Category:Basic is not supported. | - |
| 403 | InvalidInstanceVersion | Source instance version is greater than the target instance version. | - |
| 403 | UnsupportedCopyDbShareToHighAvailability | Replicate Database from RDS Category:Share to RDS Category:HighAvailability is not supported. | - |
| 403 | UnsupportedCopyDbAlwaysOnToBasic | Replicate Database from RDS Category:AlwaysOn to RDS Category:Basic is not supported. | - |
| 403 | UnsupportedCopyDbBasicToShare | Replicate Database from RDS Category:Basic to RDS Category:Share is not supported. | - |
| 403 | UnsupportedCopyDbAlwaysOnToHighAvailability | Replicate Database from RDS Category:AlwaysOn to RDS Category:HighAvailability is not supported. | - |
| 403 | UnsupportedCopyDbShareToBasic | Replicate Database from RDS Category:Share to RDS Category:Basic is not supported. | - |
| 403 | UnsupportedCopyDbHighAvailabilityToShare | Replicate Database from RDS Category:HighAvailability to RDS Category:Share is not supported. | - |
| 403 | UnsupportedCopyDbShareToAlwaysOn | Replicate Database from RDS Category:Share to RDS Category:AlwaysOn is not supported. | - |
| 403 | UnsupportedCopyDbAlwaysOnToShare | Replicate Database from RDS Category:AlwaysOn to RDS Category:Share is not supported. | - |
| 403 | InvalidParamTableMeta.RestoreTime | The specified restore time cannot be covered by the existing backup chain. Please try specifying a different restore time. | - |
| 404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | The RDS instance cannot be found. Check the ID or name of the RDS instance. |
| 404 | InvalidInstanceStorageType.NotFound | The specified DBInstanceStorageType is not found. | You must specify the InstanceStorageType parameter. |
| 404 | InvalidRegion.NotFound | Specified Region does not exist in the RDS | The region ID is invalid. |
| 404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | The vSwitch ID is invalid. |
| 404 | InsufficientResourceCapacity | Current cluster resources are insufficient. Try again later. | Current cluster resources are insufficient. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-03-24 | The error codes of the API operation change. | |||||||||
| ||||||||||
| 2022-10-28 | The error codes of the API operation change. | |||||||||
| ||||||||||
| 2022-07-19 | The error codes of the API operation change. | |||||||||
|