ImportUserBackupFile - 导入用户备份

更新时间: 2023-09-26 15:02:32

将自建库MySQL的备份数据导入至RDS。

接口说明

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

调用本接口,您需要满足下述条件:

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:ImportUserBackupFileWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

说明
  • 本参数的值为您希望创建RDS实例的地域ID。
  • 需要和BucketRegion参数的值保持一致。
  • cn-hangzhou
    EngineVersionstring

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

    5.7
    BucketRegionstring

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

    cn-hangzhou
    BackupFilestring

    描述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"}
    Commentstring

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

    BackupTest
    RestoreSizeinteger

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

    说明
  • 默认为备份文件的5倍大小。
  • 最小值为20。
  • 20
    Retentioninteger

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

    30
    ZoneIdstring

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

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

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

    rg-acfmy****

    返回参数

    名称类型描述示例值
    object
    Statusboolean

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

    true
    RequestIdstring

    请求ID。

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

    用户备份ID。

    b-n8tpg24c6i0v********

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400InvalidOssBackupFile.InvalidFileThe specified OSS backup file is invalid.操作失败,指定的OSS备份文件无效。
    400OperationDenied.ProductThe product code is not supported.不支持产品代码。

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

    变更历史

    变更时间变更内容概要操作
    2023-07-25OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:ResourceGroupId
    2022-06-23OpenAPI 描述信息更新,OpenAPI 错误码发生变更看变更集
    变更项变更内容
    API 描述OpenAPI 描述信息更新
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    阿里云首页 云数据库 RDS 相关技术圈