调用ImportUserBackupFile接口将自建库MySQL的备份数据导入至RDS。

说明 用户备份即MySQL自建库的全量备份数据，您可以将用户备份恢复至云上。

调用本接口，您需要满足下述条件：

说明 本接口当前仅适用于MySQL 5.7。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ImportUserBackupFile

系统规定参数。取值：ImportUserBackupFile。

BackupFile String 是 {"Bucket":"test", "Object":"test/test_db_employees.xb","Location":"ap-southeast-1"}

描述OSS Bucket中备份文件信息的JSON数组。示例：

{"Bucket":"test", "Object":"test/test_db_employees.xb","Location":"ap-southeast-1"}

数组中各参数的说明如下：

  • Bucket：备份文件所在OSS Bucket的名称。可调用GetBucket获取。
  • Object：备份文件所在目录的详细路径。可调用GetObject获取。
  • Location：OSS Bucket所在地域的ID。可调用GetBucketLocation获取。
BucketRegion String 是 cn-hangzhou

自建MySQL 5.7备份文件所在OSS Bucket的地域ID。可调用DescribeRegions获取。

EngineVersion String 是 5.7

MySQL数据库的版本号。当前仅支持传入5.7。

RegionId String 是 cn-hangzhou

RDS地域ID。可调用DescribeRegions获取。

说明
  • 本参数的值为您希望创建RDS实例的地域ID。
  • 需要和BucketRegion参数的值保持一致。
Comment String 否 BackupTest

要导入的用户备份的备注信息。
RestoreSize Integer 否 20

还原用户备份所需存储空间大小。单位：GB。

说明
  • 默认为备份文件的5倍大小。
  • 最小值为20。
Retention Integer 否 30

用户备份文件保留时长。单位：天。取值为大于0的Integer类型整数。

ZoneId String 否 cn-hangzhou-b

可用区ID。可调用DescribeRegions查询。

说明
  • 设置可用区后，系统会在该可用区内创建一个秒级快照，大幅节省备份导入所需要的时间。
  • 调用CreateDBInstance使用用户备份创建新实例时，该可用区即为新实例所在的可用区。

返回数据

名称 类型 示例值 描述
BackupId String b-n8tpg24c6i0v********

用户备份ID。
RequestId String A140DD14-DCC9-4548-9C72-52A49A58A310

请求ID。
Status Boolean true

导入用户备份是否成功。是则返回true，否则返回错误信息。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=ImportUserBackupFile
&BackupFile={"Bucket":"test", "Object":"test/test_db_employees.xb","Location":"ap-southeast-1"}
&BucketRegion=cn-hangzhou
&EngineVersion=5.7
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

<ImportUserBackupFileResponse>
      <RequestId>A140DD14-DCC9-4548-9C72-52A49A58A310</RequestId>
      <BackupId>b-n8tpg24c6i0v********</BackupId>
      <Status>true</Status>
</ImportUserBackupFileResponse>

JSON格式 

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidOssBackupFile.InvalidFile The specified OSS backup file is invalid. 指定的OSS备份文件无效
400 OperationDenied.Product The product code is not supported. 不支持产品代码

访问错误中心查看更多错误码。