# 库级时间点恢复 - BatchRestoreDatabase #### 功能介绍 库级时间点恢复。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=BatchRestoreDatabase)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | 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](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求消息 表2参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | instances | 是 | Array of objects | **参数解释：** 库级恢复实例信息。详细说明请参见[表3]。 **约束限制**： 不涉及。 | 表3instances字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | restore_time | 是 | Long | **参数解释：** 恢复时间点，采用毫秒时间戳。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID。 **约束限制**： 不涉及。 **取值范围**： 该参数值可调用[查询指定时间点可恢复的库](https://support.huaweicloud.com/api-rds/rds_09_0021.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_09_0021.html#rds_09_0021__zh-cn_topic_0000001643230150_table395145715268)中的"id"获取。 **默认取值**： 不涉及。 | | databases | 是 | Array of objects | **参数解释：** 库信息。详细说明请参见[表4]。 **约束限制**： 不涉及。 | | is_fast_restore | 否 | Boolean | **参数解释：** 是否使用极速恢复。 **约束限制**： - 配置该参数时，参考[查询实例是否能在库表恢复时使用极速恢复（MySQL） - ListInstancesSupportFastRestore](https://support.huaweicloud.com/api-rds/rds_09_0019.html)接口判断本次恢复是否能使用极速恢复。能使用极速恢复时，如果实例存在XA事务，会导致数据丢失，请选择普通恢复，即设置参数值为"false"。 - 不传该参数时，将根据[查询实例是否能在库表恢复时使用极速恢复（MySQL） - ListInstancesSupportFastRestore](https://support.huaweicloud.com/api-rds/rds_09_0019.html)的查询结果，默认是否使用极速恢复。如果支持极速恢复功能，并且实例存在XA事务，请选择普通恢复，即传参并设置参数值为"false"。 **取值范围**： - true：使用极速恢复。 - false：不使用极速恢复。 **默认取值**： 不涉及。 | 表4databases字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | old_name | 是 | String | **参数解释：** 恢复前库名。不支持含中文的库名。 **约束限制**： 不涉及。 **取值范围**： 该参数值可调用[查询指定时间点可恢复的库](https://support.huaweicloud.com/api-rds/rds_09_0021.html)接口，通过[表5](https://support.huaweicloud.com/api-rds/rds_09_0021.html#rds_09_0021__zh-cn_topic_0000001643230150_table46601532182710)中的"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]。 | 表6restore_result字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | **参数解释：** 实例ID。 **取值范围**： 不涉及。 | | job_id | String | **参数解释：** 工作流ID。 **取值范围**： 不涉及。 | - 正常响应样例 RDS for MySQL实例恢复指定库到指定时间点： ``` { "restore_result" : [ { "instance_id" : " 5d742eda6e574ff3a003191638ef8c51in01", "job_id" : "749d6254-f4f0-4f72-aa32-876e220d2496" } ] } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。