文档

RestoreInstance - 恢复数据到指定Redis实例

更新时间:

将备份文件中的数据恢复到指定的Redis实例中。

接口说明

说明
  • 当您的实例为内存型(兼容 Redis 5.0)持久内存型,且已开启了数据闪回,您可以调用本接口将指定 Key 的数据恢复至某个秒级时间点,其他的 Key 不受影响,可实现更精细化的数据恢复。
  • 除上述以外的实例,调用本接口会使用备份数据覆盖 Redis 实例的现有数据,存在较大风险,请务必谨慎操作。 推荐调用 CreateInstance 接口,将备份数据恢复至新实例中。
  • 调试

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

    授权信息

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

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

    请求参数

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

    实例 ID。

    r-bp1zxszhcgatnx****
    BackupIdstring

    备份文件 ID。您可以调用 DescribeBackups 查询。

    78241****
    RestoreTypestring

    恢复类型,取值:

    • 0:默认值,恢复指定的备份集。
    • 1:恢复至指定的时间点,仅当实例开启了数据闪回功能时,您才可以传入该值。传入为该值时,您还需要传入 RestoreTime 参数。
    1
    RestoreTimestring

    要恢复的时间点,格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

    说明
  • 当实例开启了数据闪回后,您可以传入本参数和 FilterKey 参数实现将指定 Key 的数据恢复至某个时间点(秒级),其他的 Key 不受影响,可实现更精细化的数据恢复。
  • 传入本参数时,要求 RestoreType 参数传入的值为 1
  • 2021-07-06T07:25:57Z
    FilterKeystring

    指定要恢复的 Key,支持正则表达式,多个值使用英文逗号(,)分隔。

    说明
  • 例如正则表达式中,星号(*)表示匹配前面子表达式任意次,本参数传入h.*llo,系统将匹配hlloheeeello等字符串。
  • 传入本参数时,要求 RestoreType 参数传入的值为 1
  • key:00000007198*
    TimeShiftstring

    对 Key 的过期时间进行偏移处理,格式为 yyyy-MM-ddTHH:mmZ(UTC 时间)。实例会将 Key 在指定闪回时间点所剩余的过期时长,偏移至设置的过期偏移时间点开始计算。

    说明 该时间点不能早于指定的闪回时间点,也不能晚于提交恢复任务的时间点。
    2021-07-06T08:25:57Z

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    8D0C0AFC-E9CD-47A4-8395-5C31BF9B****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "8D0C0AFC-E9CD-47A4-8395-5C31BF9B****"
    }

    错误码

    HTTP status code错误码错误信息
    400ServiceNotSupportThis service not supported.
    400MissingParameterMissing Required Param: BackupId or RestoreTime or RestoreType.
    400ResroreParamNotMatchrestoreType is not match with backupId or restoreTime.
    400InvalidRestoreTime.FormatSpecified restore time is not valid.
    400ZoneMigrationError.StillingRunningZone migration task is still running
    400InvalidBinlog.NotValidThe available binlog is not valid in recovery time.

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

    变更历史

    变更时间变更内容概要操作
    2023-07-20OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
    变更项变更内容
    API 描述OpenAPI 描述信息更新
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    2022-11-22OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:TimeShift
    • 本页导读 (1)
    文档反馈