All Products
Search
Document Center

ApsaraDB RDS:CreateDdrInstance

Last Updated:Apr 17, 2024

Restores data to a new instance across regions.

Operation description

Note Before restoration, you can call the CheckCreateDdrDBInstance operation to check whether a cross-region backup set can be used for cross-region restoration.

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:CreateDdrInstanceWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the destination instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
EnginestringYes

The database engine of the destination instance. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
MySQL
EngineVersionstringYes

The major engine version of the destination instance. The value of this parameter varies based on the value of Engine.

  • Valid values when Engine is set to MySQL: 5.5, 5.6, 5.7, and 8.0
  • Valid values when Engine is set to SQLServer: 2008r2, 08r2_ent_ha, 2012, 2012_ent_ha, 2012_std_ha, 2012_web, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_std_ha, 2017_ent, 2019_std_ha, and 2019_ent
  • Valid values when Engine is set to PostgreSQL: 9.4, 10.0, 11.0, 12.0, and 13.0
5.6
DBInstanceClassstringYes

The instance type of the destination instance. For more information, see Primary ApsaraDB RDS instance types.

rds.mysql.s1.small
DBInstanceStorageintegerYes

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB. You can increase the storage capacity at a step size of 5 GB. For more information, see Primary instance types.

20
SystemDBCharsetstringNo

The character set of the destination instance. Valid values:

  • utf8
  • gbk
  • latin1
  • utf8mb4
uft8
DBInstanceNetTypestringYes

The network connection type of the destination instance. Valid values:

  • Internet
  • Intranet
Intranet
DBInstanceDescriptionstringNo

The instance name. The name must be 2 to 256 characters in length. The value can contain letters, digits, underscores (_), and hyphens (-), and must start with a letter.

Note The value cannot start with http:// or https://.
Test database
SecurityIPListstringYes

The IP address whitelist of the destination instance. If you want to add more than one entry to the IP address whitelist, separate the entries with commas (,). Each entry must be unique. You can add a maximum of 1,000 entries. For more information, see Configure an IP address whitelist for an ApsaraDB RDS for MySQL instance. The entries in the IP address whitelist must be in one of the following formats:

  • IP address. Example: 10.23.12.24.
  • CIDR block. Example: 10.23.12.24/24. In this example, 24 indicates that the prefix of the CIDR block is 24 bits in length. You can replace 24 with a value that ranges from 1 to 32.
127.0.0.1
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCzxxxxxxxxxx
PayTypestringYes

The billing method of the instance. Valid values:

  • Postpaid: pay-as-you-go
  • Prepaid: subscription
Prepaid
ZoneIdstringNo

The zone ID of the destination instance. If the destination instance is deployed in multiple zones, separate the IDs of the zones with colons (:).

Note If you specify a virtual private cloud (VPC) and a vSwitch, you must specify this parameter to identify the zone for the vSwitch.
cn-hangzhou-b
InstanceNetworkTypestringNo

The network type of the instance. Valid values:

  • VPC
  • Classic

Default value: Classic.

Note If you set this parameter to VPC, you must also specify VpcId and VSwitchId.
Classic
ConnectionModestringNo

The connection mode of the destination instance. Valid values:

  • Standard: standard mode
  • Safe: database proxy mode

Default value: Standard.

Standard
VPCIdstringNo

The VPC ID of the destination instance. This parameter is available only when you set the InstanceNetworkType parameter to VPC.

Note If you specify this parameter, you must also specify the ZoneId parameter.
vpc-xxxxxxxxxxxx
VSwitchIdstringNo

The vSwitch ID of the destination instance. If you specify more than one vSwitch, separate the IDs of the vSwitches with commas (,). This parameter is available only when you set the InstanceNetworkType parameter to VPC.

Note If you specify this parameter, you must also specify the ZoneId parameter.
vsw-xxxxxxxxxxx
PrivateIpAddressstringNo

The private IP address of the destination instance. The private IP address must be within the CIDR block that is supported by the specified vSwitch. The system automatically assigns an internal IP address based on the values of the VPCId and VSwitchId parameters.

172.XXX.XXX.69
UsedTimestringNo

The subscription duration of the instance.

  • If you set Period to Year, the value of UsedTime ranges from 1 to 3.
  • If you set Period to Month, the value of UsedTime ranges from 1 to 9.
Note If you set PayType to Prepaid, you must specify UsedTime.
2
PeriodstringNo

The unit that is used to measure the subscription duration of the destination instance. Valid values:

  • Year
  • Month
Note If you set PayType to Prepaid, you must specify UsedTime.
Year
ResourceGroupIdstringNo

The resource group ID.

rg-acfmyxxxxxxxxxx
RestoreTypestringYes

The restoration method that you want to use. Valid values:

  • BackupSet: restores data from a backup set. If you use this value, you must also specify BackupSetId.
  • BackupTime: restores data to a point in time. If you use this value, you must also specify RestoreTime, SourceRegion, and SourceDBInstanceName.
BackupSet
BackupSetIdstringNo

The backup set ID that you want to use for the restoration. You can call the DescribeCrossRegionBackups operation to query backup set ID.

Note This parameter is required when you set the RestoreType parameter to BackupSet.
14***
RestoreTimestringNo

The point in time to which you want to restore data. The point in time that you specify must be earlier than the current time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note If RestoreType is set to BackupTime, you must specify this parameter.
2019-05-30T03:29:10Z
SourceRegionstringNo

The region ID of the source instance if you want to restore data to a point in time.

Note If you set RestoreType to BackupTime, you must specify this parameter.
cn-hangzhou
SourceDBInstanceNamestringNo

The source instance ID, which is used if you want to restore data to a point in time.

Note This parameter is required when you set the RestoreType parameter to BackupTime.
rm-uf6wjk5xxxxxxx
DBInstanceStorageTypestringNo

The storage type of the destination instance. Only the local SSD storage type is supported. Default value: local_ssd.

local_ssd

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

DBInstanceIdstring

The destination instance ID.

rm-xxxxx
RequestIdstring

The ID of the request.

E52666CC-330E-418A-8E5B-A19E3FB42D13
Portstring

The port number that is used to connect to the destination instance.

Note DBInstanceNetType indicates whether the port is internal or public.
3306
ConnectionStringstring

The endpoint that is used to connect to the destination instance.

Note The DBInstanceNetType parameter indicates whether the endpoint is internal or public.
rm-xxxxx.mysql.rds.aliyuncs.com
OrderIdstring

The order ID.

2038691xxxxx

Examples

Sample success responses

JSONformat

{
  "DBInstanceId": "rm-xxxxx",
  "RequestId": "E52666CC-330E-418A-8E5B-A19E3FB42D13",
  "Port": "3306",
  "ConnectionString": "rm-xxxxx.mysql.rds.aliyuncs.com",
  "OrderId": "2038691xxxxx"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidZoneId.NotSupportedThe Specified vpc Zone not supported.VPC-hosted RDS instances cannot be created in the zone. Specify a different zone.
400InvalidDBInstanceName.FormatSpecified DB instance name is not valid.The instance does not exist. Check the instance information.
400InvalidDBInstanceName.DuplicateSpecified DB instance name already exists in the Aliyun RDS.The operation failed. The instance name already exists. Specify a different name and try again.
400InvalidRegion.FormatSpecified Region is not valid.The region ID is invalid. Check the region ID.
400InvalidServiceType.FormatSpecified service type is not valid.The service type is invalid. Set the service type to 0 or 1. The value 0 indicates an Alibaba Cloud service, and the value 1 indicates a JST service.
400InvalidEngine.MalformedSpecified engine is not valid.The database engine is invalid. Specify a valid database engine.
400InvalidEngineVersion.MalformedSpecified engine version is not valid.The database engine version is invalid. Check the database engine version and try again.
400InvalidConnectionString.FormatSpecified connection string is not valid.The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length.
400InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.The endpoint is duplicate. Specify a different endpoint.
400InvalidCharacterSetName.FormatSpecified character set name is not valid.The character set is invalid. ApsaraDB RDS supports the following character sets: gbk, utf8, euckr, and ascii.
400InvalidDBInstanceType.FormatSpecified instance type is not valid.The operation failed. The database engine is invalid. Specify a valid database engine.
400InvalidPort.MalformedSpecified port is not valid.The port number is invalid.
400InvalidBackupRetentionPeriod.MalformedSpecified backup retention period is not valid.The backup cycle is invalid. The backup cycle must be greater than 1 day and less than or equal to 30 days.
400InvalidPreferredBackupTime.FormatSpecified preferred backup time is not valid.The time of the backup file is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2012-06-11T15:00Z.
400InvalidPreferredBackupPeriod.MalformedSpecified backup period is not valid.The backup time is invalid.
400InvalidOptmizationServiceSpecified optmization service is not valid.-
400InvalidExpiredTime.FormatSpecified expired time is not valid.The value of the ExpiredTime parameter is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400InvalidSecurityIPList.FormatSpecified security IP list format is not valid.The IP address whitelist is invalid. Check the IP address whitelist.
400InvalidSecurityIPList.DuplicateSpecified security IP list is not valid: Duplicate IP address in the listThe IP address whitelist is invalid. The whitelist contains duplicate entries.
400InvalidSecurityIPList.QuotaExceededSpecified security IP list is not valid: Exceeding the allowed amount of IP address in the list.The number of IP addresses and CIDR blocks in the IP address whitelist that is specified by the SecurityIPList parameter exceeds the upper limit. The IP address whitelist can contain a maximum of 1,000 IP addresses and CIDR blocks.
400InvalidDBInstanceDescription.FormatSpecified DB instance description is not valid.-
400InvalidStorage.FormatSpecified Storage is not valid.The value of the Storage parameter is invalid. Specify a valid value.
400InvalidDBInstanceConnType.FormatSpecified DB instance conn type is not valid.The operation failed. The operation is not supported for the connection type of the RDS instance.
400PreCheckInvalidCreateDdrInstance PreCheck Is InvalidThe precheck for CreateDdrInstance is invalid.
400IncorrectDBInstanceTypeCurrent 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.
400InvalidRestoreType.FormatSpecified restore type is not valid.The restoration type is invalid. Specify a valid restoration type.
400NoBackupSetRegionBackupSetRegion is absence.The backup region does not exist.
400IncorrectBackupSetTypeBackup set type should be value ddr.-
400NoBaksetNameBaksetName is absence.The backup set name does not exist.
400NoSourceInstanceNameNo SourceDBInstanceName.The source instance name is not found.
400NoAvailableDisasterRestoreBaksetNo available disaster restore bakset.No available restore set is found.
400InvalidBackupType.FormatSpecified backup type is not valid.The operation failed. The backup type is invalid.
400IncorrectEngineVersionCurrent engine version does not support operations.The operation failed. The operation is not supported for the version of the database engine that is run on the RDS instance.
400DisasterRestoreRegionNotMatchedDisaster restore should be operated in the ddr region or source region.-
400InvalidVpcIdRegion.NotSupportedThe Specified vSwitchId zone not supported.-
400VswitchIpExhaustedNo available ip in the specified vswitch.No available IP address exists in the specified vSwitch.
403IncorrectBackupSetMethodCurrent backup set method does not support operations.The operation failed. The data backup file does not support the restoration of individual databases and tables.
403IncorrectBaksetVersionCurrent bakset version does not support operations.The operation failed. The operation is not supported for the version of the data backup file.
403CrossRegionUnsupportTDECross-region disaster restore not support TDE bakset.-
404InvalidRegion.NotFoundSpecified Region does not exist in the RDSThe region ID is invalid.
404InvalidClusterName.NotFoundThe specified cluster name is not available.The operation failed. The instance name cannot be found. Check the instance name and try again.
404InvalidDBInstanceClass.NotFoundSpecified DB instance class is not found.The configuration or the instance type cannot be found or has been discontinued. Specify a different configuration or a different instance type.
404InvalidDBInstanceNetType.NotFoundSpecified DB instance net type is not found.The operation failed. The network type of the RDS instance is invalid. Specify a valid network type.
404RestoreType.NotFoundRestoreType is not found.RestoreType is not found.
404InvalidBackupSetID.NotFoundSpecified backup set ID does not exist.The backup set does not exist. Specify an available backup set.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-14The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
    delete Error Codes: 404
2023-01-11The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
2022-09-01The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
    delete Error Codes: 404