All Products
Search

This Product

    ApsaraDB RDS:RecoveryDBInstance

    Document Center

    ApsaraDB RDS:RecoveryDBInstance

    Last Updated:Nov 22, 2024

    Restores backup data of an ApsaraDB RDS for SQL Server instance to an existing instance or a new instance.

    Operation description

    Supported database engines

    SQL Server 2012 or later

    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.

    Restore the data of an ApsaraDB RDS for SQL Server instance

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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:RecoveryDBInstancecreate
    *DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceClassstringNo

    The instance type of the new instance. For more information, see Instance types.

    		rds.mysql.s2.large
    DBInstanceStorageintegerNo

    The storage capacity of the new instance. Unit: GB. For more information, see Instance types.

    Note You must set this parameter to a value that is greater than or equal to the storage capacity of the original instance.
    		5
    PayTypestringNo

    The billing method of the new instance. Valid values:

    • Postpaid: pay-as-you-go.
    • Prepaid: subscription.
    		Postpaid
    InstanceNetworkTypestringNo

    The network type of the new instance. Valid values:

    • Classic
    • VPC

    By default, the new instance uses the same network type as the original instance.

    		VPC
    DBInstanceIdstringNo

    The ID of the original instance.

    Note
  • If you specify BackupId, you do not need to specify this parameter.
  • If you specify RestoreTime, you must also specify this parameter.
    •
    		rm-xxxxxxxx1
    TargetDBInstanceIdstringNo

    The ID of the destination instance.

    		rm-uf6wjk5xxxxxxx
    DbNamesstringYes

    The name of the database. When you restore data to a new instance, the format of the database name is Original database name 1,New database name 2.

    Note For more information about how to restore data to an existing instance, see CopyDatabaseBetweenInstances .
    		Restore databases to a new instance: test1,test2. Restore databases to an existing instance: {"test1":"newtest1","test2":"newtest2"}
    BackupIdstringNo

    The backup set ID. You can call the DescribeBackups operation to query the backup set ID.

    If you specify this parameter, you do not need to specify DBInstanceId.

    Note You must specify at least one of the BackupId or RestoreTime parameters.
    		29304****
    RestoreTimestringNo

    The point in time to which you want to restore data. The point in time must fall within the specified log 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.

    If you specify this parameter, you must also specify DBInstanceId.

    Note You must specify at least one of BackupId and RestoreTime.
    		2011-06-11T16:00:00Z
    VPCIdstringNo

    The VPC ID of the new instance.

    		vpc-xxxxxxxxxxx
    VSwitchIdstringNo

    The vSwitch ID of the new instance. If you specify more than one vSwitch ID, you must separate the IDs with commas (,).

    		vsw-xxxxxxxxxxx
    PrivateIpAddressstringNo

    The internal IP address of the new instance. The internal 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. Valid values:

    • Valid values when Period is set to Year: 1 to 3.****
    • Valid values when Period is set to Month: 1 to 9.****
    Note This parameter must be specified when PayType is set to Prepaid.
    		1
    PeriodstringNo

    The unit that is used to calculate the billing cycle of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:

    • Year
    • Month
    Note This parameter must be specified when PayType is set to Prepaid.
    		Month
    DBInstanceStorageTypestringNo

    The storage type of the new instance. Valid values:

    • local_ssd/ephemeral_ssd: local SSD
    • cloud_ssd: standard SSD.
    • cloud_essd: enhanced SSD (ESSD)
    		local_ssd

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    DBInstanceIdstring

    The instance ID.

    		rm-xxxxxxx
    RequestIdstring

    The request ID.

    		EFB6083A-7699-489B-8278-C0CB4793A96E
    OrderIdstring

    The order ID.

    		54325****

    Examples

    Sample success responses

    JSONformat

    {
  "DBInstanceId": "rm-xxxxxxx",
  "RequestId": "EFB6083A-7699-489B-8278-C0CB4793A96E",
  "OrderId": "54325****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalParameterillegal parameter, param is empty.The values of some parameters are invalid.
    400InvalidRecoveryDbInstance.StorageSizeThe disk space of the new instance cannot be less than that of the current instanceThe 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.
    400DBCountLimitExceededDb count limit exceeded.The number of databases is exceeded.
    400UnsupportExtendDisk.NotSupportSpecified DB instance is unsupport extend disk.Disk expansion is not supported on the specified instance.
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
    400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
    400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
    400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Hello customer, this area has been abolished.
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Hello customer, this area has been abolished.
    400Price.CommoditySysCommodity system call exception.Commodity system call exception.
    400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
    400pay.noCreditCardAccount not bound to credit card.-
    400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
    400Api.NotSupportSpecified api is not supported.The current interface does not support.
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
    400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
    400KmsApiErrorUser secret key invalid.The user key is invalid.
    400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
    400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
    400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
    400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.The current instance engine version not support coldDataEnabled.
    400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.The current instance minor version not support coldDataEnabled.
    400IncorrectTargetClasscodeThe current instance type does not support this operation.This operation is not supported by the instance type.
    400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.The link address name is duplicate. Please reset the connection string.
    400RequiredParam.NotFoundRequired input param is not found.-
    400Parameters.InvalidParameter error, please check the parameters.Parameter error, please check the parameters.
    400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
    400InvalideStatus.FormatThe instance status does not support this operation.-
    400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.Specified Released Keep Policy is not valid.
    400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
    400Pay.NoCreditCardNo credit cards.No credit cards.
    400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.The vpc network type instance does not support this operation.
    400MirrorInsExistsSpecified DB instance mirror ins already existed.Specified DB instance mirror ins already existed.
    400UnsupportedClassCodeThe specified DB instance class stops selling.The specified DB instance class stops selling.
    400InvalidBackupSetThe specified database does not exist in the backup set.The specified database does not exist in the backup set.
    400OrdTCommodityQueryErrorFailed to query for product.Failed to query product.
    400ProductInstanceReleasedThe instance has been released. Please check before placing the order.The instance has been released, please verify and place an order.
    403Forbidden.SnapshotRecoverySnapshot backup does not support partial restoreThe operation failed. Snapshot backup files cannot be used to restore only a specific part of data.
    403StorageLimitExceededExceeding the allowed Storage of DB instance-
    403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
    403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
    403InvalidVswitchIdSpecified conn vswitch id is not valid.-
    403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
    403OperationDenied.ZoneResourceThere is no available zone for inventory.There is no available zone for inventory.
    403NotInFlowControllerSorry,no permission.Sorry,no permission.
    403InvalidKmsKeyKms key is disabled.-
    403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.The specified database instance type does not support this operation.
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
    404Request.NotFoundThe requested resource is not available.The requested resources are unavailable.
    404HostInfo.NotFoundThe specified host info is not found.-
    500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.
    500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.The service request failed. Please try again later or contact service personnel.
    500InvokeProxyFailureThe request processing has failed due to service failure of rds api.The request failed to be processed due to an RDS API failure.

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

    Change history

    Change timeSummary of changesOperation
    2024-11-12API Description Update. The Error code has changedView Change Details
    2024-08-20The Error code has changedView Change Details
    2023-09-08The Error code has changedView Change Details
    2023-06-09The Error code has changedView Change Details