全部产品
Search

搜索本产品

    云数据库 RDS：ImportUserBackupFile - 导入用户备份

    文档中心

    云数据库 RDS：ImportUserBackupFile - 导入用户备份

    更新时间：Aug 28, 2026

    该接口用于将自建库MySQL 5.7的备份数据导入至RDS。

    接口说明

    适用引擎

    • RDS MySQL

    功能说明

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

    注意事项

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

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    rds:ImportUserBackupFile

    create

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    RegionId

    string

    是

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

    说明

    • 本参数的值为您希望创建 RDS 实例的地域 ID。

    • 需要和 BucketRegion 参数的值保持一致。

    cn-hangzhou
    Mode

    string

    否

    导入模式，取值说明：

    • oss：从 OSS 下载备份导入。

    • stream：通过网络导入备份。

    oss
    EngineVersion

    string

    否

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

    5.7
    BucketRegion

    string

    否

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

    cn-hangzhou
    BackupFile

    string

    否

    描述 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 获取。

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

    string

    否

    要导入的用户备份的备注信息。

    BackupTest
    RestoreSize

    integer

    否

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

    说明

    • 默认为备份文件的 5 倍大小。

    • 最小值为 20。

    20
    Retention

    integer

    否

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

    30
    ZoneId

    string

    否

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

    说明

    • 设置可用区后，系统会在该可用区内创建一个秒级快照，大幅节省备份导入所需要的时间。

    • 调用 CreateDBInstance 使用用户备份创建新实例时，该可用区即为新实例所在的可用区。

    cn-hangzhou-b
    ResourceGroupId

    string

    否

    资源组 ID。可调用 DescribeDBInstanceAttribute 获取。

    rg-acfmy****
    DBInstanceId

    string

    否

    实例 ID。

    rm-uf6wjk5****
    SourceInfo

    string

    否

    提供全量备份的源端信息的 JSON 数组（大小写敏感）。示例：

    {"sourceIp":"172.20.xx
.xx","sourcePort":"9999"}

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

    • sourceIp：源端 IP。

    • sourcePort：源端 Netcat 监听的端口。

    说明

    仅对原生复制实例生效，需要在调用 API 时传入DBInstanceId参数。

    {"sourceIp":"172.20.xx.xx","sourcePort":"9999"}
    BuildReplication

    boolean

    否

    是否自动搭建复制，取值说明：

    • true：是，MasterInfo参数必填。

    • false：否。

    说明

    仅对原生复制实例生效，需要在调用 API 时传入DBInstanceId参数。

    true
    MasterInfo

    string

    否

    搭建 MySQL 复制的 Master 信息的 JSON 数组（大小写敏感）。示例：

    {"masterIp":"172.20.xx.xx","masterPort":"3306","masterUser":"replica","masterPassword":"W33uopkehBQ="}

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

    • masterIp：主库 IP。

    • masterPort：主库端口。

    • masterUser：主库复制账号。

    • masterPassword：主库复制账号密码，需要进行 Base64 加密。

    说明

    仅对原生复制实例生效，需要在调用 API 时传入DBInstanceId参数。

    {"masterIp":"172.20.xx.xx","masterPort":"3306","masterUser":"replica","masterPassword":"W33uopkehBQ="}

    返回参数

    名称

    类型

    描述

    示例值

    object

    返回参数详情。

    BackupId

    string

    用户备份 ID。

    b-n8tpg24c6i0v****
    RequestId

    string

    请求 ID。

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

    boolean

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

    true

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 InvalidOssBackupFile.InvalidFile The specified OSS backup file is invalid. 操作失败，指定的OSS备份文件无效。
    400 OperationDenied.Product The product code is not supported.
    400 InvalidBackupFile.Format The specified params BackupFile(BackupId or RestoreTime or BackupFile) is not valid. 指定的参数BackupFile（BackupId、RestoreTime或BackupFile）无效。
    400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. 套餐实例不允许单独操作。
    400 Price.PricingPlanResultNotFound Pricing plan price result not found. 定价计划价格结果没有找到。
    400 Order.NoRealNameAuthentication You 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. 您还未通过实名认证，不符合购买条件，请登录费用与成本进行实名认证。
    400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. 您的账户可用额度小于0，请先充值后再尝试购买。
    400 CommodityServiceCalling.Exception Failed to call commodity service. 调用商品服务返回失败。
    400 RegionDissolvedEOM Dear 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. 客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
    400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. 您购买的模块不合法，请重新购买。
    400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. 客户您好，该地域已裁撤。
    400 Price.CommoditySys Commodity system call exception. 商品系统调用异常。
    400 Pay.InsufficientBalance Insufficient available balance. 可用金不足。
    400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. 您选购的周期有问题，请重新选购。
    400 pay.noCreditCard Account not bound to credit card. 账户未绑定信用卡。
    400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. 您选购的服务存在未支付订单，请支付或作废后再下单。
    400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method. 没有为您的账户指定付款方式。我们建议您添加一种付款方式。
    400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. 您的基本信息未完善，请在操作前先完善您的基本信息。
    400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. 您的账户出现异常，详情请联系客服。
    400 Api.NotSupport Specified api is not supported. 当前接口不支持。
    400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. 存在禁止下单的标签，请联系您的分销商处理
    400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. 提供的DBInstanceId不存在。
    400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type 当前实例规格不支持该存储类型。
    400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. 指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为replica。
    400 KmsApiError User secret key invalid. 用户密钥失效。
    400 System.SaleValidateFailed Sales expression validation system error. 销售表达式校验系统错误。
    400 Abs.InvalidAccount.NotFound account is not found. 账户不存在。
    400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. sql命令执行失败或执行超时
    400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. 当前实例引擎版本不支持归档冷数据。
    400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. 当前内核版本不支持归档冷数据。
    400 IncorrectTargetClasscode The current instance type does not support this operation. 当前规格不支持此操作。
    400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. 链接地址名重复，请重新设置连接字符串。
    400 RequiredParam.NotFound Required input param is not found. 没有传入必要的参数。
    400 Parameters.Invalid Parameter error, please check the parameters. 参数错误，请检查参数。
    400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. 数据归档不支持跨地域备份和秒级快照，请检查备份策略。
    400 InvalideStatus.Format The instance status does not support this operation. 实例状态不支持此操作。
    400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. 实例释放后的归档备份保留策略无效。
    400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. DB实例引擎类型不支持此操作。
    400 Pay.NoCreditCard No credit cards. 无信用卡。
    400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. vpc网络类型实例不支持此操作。
    400 MirrorInsExists Specified DB instance mirror ins already existed. 当前数据库实例镜像已存在。
    400 UnsupportedClassCode The specified DB instance class stops selling. 实例规格停止售卖。
    400 InvalidBackupSet The specified database does not exist in the backup set. 备份集中没有指定的数据库。
    400 OrdTCommodityQueryError Failed to query for product. 查询产品失败。
    400 ProductInstanceReleased The instance has been released. Please check before placing the order. 实例已释放，请核实后下单。
    400 RegionEndTimeDissolvedIndia The region is no longer supported. 指定的地域无效。
    400 InvalidUserBakset The user backup set to be imported is invalid. 导入的用户备份有误
    500 ExternalFailure The request processing has failed due to external service failure. 请求服务失败，请稍后重试。
    500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. 请求服务失败，请稍后再试或联系服务人员。
    500 InvokeProxyFailure The request processing has failed due to service failure of rds api. 由于rds api服务失败，请求处理失败。
    403 OrderStatus.UnPaid The specified db instance has unpaid order. 实例当前存在未支付订单，请支付后重试。
    403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. 缩容目标容量不能小于当前存储空间使用量
    403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd. SSD盘不支持此操作，请升级至ESSD。
    403 InvalidUserOperatorPermission The user permission does not support this operation. 用户权限不支持此操作。
    403 InvalidVswitchId Specified conn vswitch id is not valid. 指定的VSwitchId格式不正确或为空
    403 IncorrectMinorVersion Current engine minor version does not support operations. 当前引擎小版本不支持此操作。
    403 OperationDenied.ZoneResource There is no available zone for inventory. 没有可用的库存区域。
    403 NotInFlowController Sorry,no permission. 非集团上云用户不可用，无权限。
    403 InvalidKmsKey Kms key is disabled. Kms key已禁用。
    403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. 当前数据库实例级别不支持此操作。
    404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. 当前实例未授权访问密钥管理服务。
    404 Request.NotFound The requested resource is not available. 请求的资源不可用。
    404 HostInfo.NotFound The specified host info is not found. 指定的主机信息不存在。

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

    变更历史

    更多信息，参考变更详情。