文档首页/云数据库 RDS/API参考/API v3（推荐）/备份与恢复/库级时间点恢复 - BatchRestoreDatabase
更新时间：2026-02-04 GMT+08:00
查看PDF
分享

库级时间点恢复 - BatchRestoreDatabase

功能介绍

库级时间点恢复。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:tableRestore

write

-

-

-

-

接口约束

  • 该接口仅支持MySQL和PostgreSQL引擎。
  • 不支持含Json虚拟列的表所在的库进行库级恢复。
  • 不支持原库名含中文的库进行库级恢复。
  • 存在XA事务，不支持极速恢复。

URI

  • URI格式

    POST /v3/{project_id}/instances/batch/restore/databases

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

    获取方法请参见获取项目ID。

    默认取值：

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

instances

是

Array of objects

参数解释：

库级恢复实例信息。详细说明请参见表3。

约束限制：

不涉及。

表3 instances字段数据结构说明

名称

是否必选

参数类型

说明

restore_time

是

Long

参数解释：

恢复时间点，采用毫秒时间戳。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

该参数值可调用查询指定时间点可恢复的库接口，通过表4中的“id”获取。

默认取值：

不涉及。

databases

是

Array of objects

参数解释：

库信息。详细说明请参见表4。

约束限制：

不涉及。

is_fast_restore

否

Boolean

参数解释：

是否使用极速恢复。

约束限制：

取值范围：

  • true：使用极速恢复。
  • false：不使用极速恢复。

默认取值：

不涉及。

表4 databases字段数据结构说明

名称

是否必选

参数类型

说明

old_name

是

String

参数解释：

恢复前库名。不支持含中文的库名。

约束限制：

不涉及。

取值范围：

该参数值可调用查询指定时间点可恢复的库接口，通过表5中的“name”获取。

默认取值：

不涉及。

new_name

是

String

参数解释：

恢复后库名。

约束限制：

不涉及。

取值范围：

支持字母、数字、中划线、下划线和$字符的组合。不支持新库名和原库名重名。

默认取值：

不涉及。

请求示例

RDS for MySQL实例恢复指定库到指定时间点。

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/batch/restore/databases
{
  "instances" : [ {  
     "instance_id" : "5d742eda6e574ff3a003191638ef8c51in01",  
     "restore_time" : 1699323939000,  
     "databases" : [ {  
       "old_name" : "dbtest",  
       "new_name" : "dbtest_restore"  
     } ]  
   } ]  
}

响应消息

  • 正常响应要素说明
    表5 要素说明

    名称

    参数类型

    说明

    restore_result

    Array of objects

    参数解释：

    库级时间点恢复任务信息。详细说明请参见表6。

    表6 restore_result字段数据结构说明

    参数

    参数类型

    描述

    instance_id

    String

    参数解释：

    实例ID。

    取值范围：

    不涉及。

    job_id

    String

    参数解释：

    工作流ID。

    取值范围：

    不涉及。

  • 正常响应样例

    RDS for MySQL实例恢复指定库到指定时间点：

    {  
   "restore_result" : [ {  
     "instance_id" : " 5d742eda6e574ff3a003191638ef8c51in01",  
     "job_id" : "749d6254-f4f0-4f72-aa32-876e220d2496"  
   } ]  
 }
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题：备份与恢复