ImportUserBackupFile - ApsaraDB RDS - Alibaba Cloud Documentation Center

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:

The self-managed MySQL instance runs MySQL 5.7 and is backed up by using XtraBackup. The name of the backup file ends with _qp.xb. For more information, see Migrate the data of a self-managed MySQL 5.7 instance to the cloud.
The full backup file of the self-managed MySQL instance is uploaded to an Object Storage Service (OSS) bucket in the region of the ApsaraDB RDS for MySQL instance. For more information, see Migrate the data of a self-managed MySQL 5.7 instance to the cloud.

Note This operation is supported only for MySQL 5.7.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
rds:ImportUserBackupFile	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	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
EngineVersion	string	Yes	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
BucketRegion	string	Yes	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
BackupFile	string	Yes	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"}
Comment	string	No	The description of the full backup file.	BackupTest
RestoreSize	integer	No	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
Retention	integer	No	The retention period of the full backup file. Unit: days. Valid values: any non-zero positive integer.	30
ZoneId	string	No	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
ResourceGroupId	string	No	The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.	rg-acfmy****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Status	boolean	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
RequestId	string	The ID of the request.	A140DD14-DCC9-4548-9C72-52A49A58A310
BackupId	string	The ID of the full backup file.	b-n8tpg24c6i0v********

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidOssBackupFile.InvalidFile	The specified OSS backup file is invalid.	The operation failed. The backup file cannot be found in the OSS bucket.
400	OperationDenied.Product	The product code is not supported.	The product code is not supported.
400	InvalidBackupFile.Format	The specified params BackupFile(BackupId or RestoreTime or BackupFile) is not valid.	The specified parameter BackupFile(BackupId, RestoreTime, or BackupFile) is invalid.

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

Change history

Change time	Summary of changes	Operation
2023-11-21	The Error code has changed	View Change Details
2023-07-25	The Error code has changed. The request parameters of the API has changed	View Change Details
2022-06-23	API Description Update. The Error code has changed	View Change Details