All Products
Search

This Product

    ApsaraDB RDS:ImportUserBackupFile

    Document Center

    ApsaraDB RDS:ImportUserBackupFile

    Last Updated:Dec 05, 2024

    Imports the backup data of a self-managed instance that runs MySQL 5.7 to an ApsaraDB RDS for MySQL instance.

    Operation description

    Supported database engines

    • MySQL

    Description

    A full backup file contains the data of a self-managed MySQL instance. You can restore the data of a self-managed MySQL instance from a full backup file to an ApsaraDB RDS for MySQL instance.

    Usage notes

    Before you call this operation, make sure that the following requirements are met:

    Note This operation is supported only for MySQL 5.7.

    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:ImportUserBackupFilecreate
    *DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

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

    Note
  • The value of this parameter is the ID of the region in which you want to create the instance.
  • The value of this parameter must be consistent with the value of BucketRegion.
    •
    		cn-hangzhou
    EngineVersionstringYes

    The version of the database engine that is run on the self-managed MySQL database and ApsaraDB RDS for MySQL instance. Set the value to 5.7.

    		5.7
    BucketRegionstringYes

    The region ID of the OSS bucket where the full backup file of the self-managed MySQL database is located. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    BackupFilestringYes

    A JSON array that consists of the information about the full backup file stored as an object in an OSS bucket. Example: {"Bucket":"test", "Object":"test/test_db_employees.xb","Location":"ap-southeast-1"}

    The JSON array contains the following fields:

    • Bucket: The name of the OSS bucket in which the full backup file is stored as an object. You can call the GetBucket operation to query the name of the bucket.
    • Object: The path of the full backup file that is stored as an object in the OSS bucket. You can call the GetObject operation to query the path of the object.
    • Location: The ID of the region in which the OSS bucket is located. You can call the GetBucketLocation operation to query the region of the bucket.
    		{"Bucket":"test", "Object":"test/test_db_employees.xb","Location":"ap-southeast-1"}
    CommentstringNo

    The description of the full backup file.

    		BackupTest
    RestoreSizeintegerNo

    The amount of storage that is required to restore the data of the full backup file. Unit: GB.

    Note
  • The default value of this parameter is 5 times the size of the full backup file.
  • The minimum value of this parameter is 20.
    •
    		20
    RetentionintegerNo

    The retention period of the full backup file. Unit: days. Valid values: any non-zero positive integer.

    		30
    ZoneIdstringNo

    The zone ID. You can call the DescribeRegions operation to query the zone ID.

    Note
  • If you specify this parameter, the system creates a snapshot in single-digit seconds, which greatly reduces the time that is required to import the full backup file.
  • When you call the CreateDBInstance operation to create an instance by using the full backup file, the instance is created in the zone that you specify for this parameter.
    •
    		cn-hangzhou-b
    ResourceGroupIdstringNo

    The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.

    		rg-acfmy****
    DBInstanceIdstringNo

    The instance ID.

    		rm-uf6wjk5****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    BackupIdstring

    The ID of the full backup file.

    		b-n8tpg24c6i0v********
    RequestIdstring

    The ID of the request.

    		A140DD14-DCC9-4548-9C72-52A49A58A310
    Statusboolean

    Indicates whether the full backup file is successfully imported into the instance. If the full backup file is successfully imported, true is returned. Otherwise, an error message is returned.

    		true

    Examples

    Sample success responses

    JSONformat

    {
  "BackupId": "b-n8tpg24c6i0v********",
  "RequestId": "A140DD14-DCC9-4548-9C72-52A49A58A310",
  "Status": true
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidOssBackupFile.InvalidFileThe specified OSS backup file is invalid.The operation failed. The backup file cannot be found in the OSS bucket.
    400OperationDenied.ProductThe product code is not supported.The product code is not supported.
    400InvalidBackupFile.FormatThe specified params BackupFile(BackupId or RestoreTime or BackupFile) is not valid.The specified parameter BackupFile(BackupId, RestoreTime, or BackupFile) is invalid.
    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.
    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.
    400RegionEndTimeDissolvedIndiaThe region is no longer supported.The region is no longer supported.
    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-14The Error code has changed. The request parameters of the API has changedView Change Details
    2023-11-21The Error code has changedView Change Details
    2023-07-25The Error code has changed. The request parameters of the API has changedView Change Details
    2022-06-23API Description Update. The Error code has changedView Change Details