# 恢复到当前实例或已有实例 - RestoringDatatotheOriginalorExistingInstance #### 功能介绍 将数据库恢复到当前实例或已有实例。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=RestoreInstance)中调试该接口。 #### URI POST /v3/{project_id}/instances/recovery 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | 表3参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | source | 是 | Object | **参数解释：** 恢复数据源对象。详情见[表4]。 **约束限制：** 不涉及。 | | target | 是 | Object | **参数解释：** 恢复目标对象。详情见[表5]。 **约束限制：** 不涉及。 | 表4source 字段数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | instance_id | 是 | String | **参数解释：** 备份所属实例ID，可通过[查询备份列表 - QueryingBackups](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_068.html)获取，此参数是用户创建实例的唯一标识。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | | type | 是 | String | **参数解释：** 恢复方式。 **约束限制：** 不涉及。 **取值范围：** - backup：表示使用备份文件恢复，按照此方式恢复时，"backup_id"必选。 - timestamp：表示按时间点恢复，按照此方式恢复时，"restore_time"必选。 **默认取值：** backup | | backup_id | 否 | String | **参数解释：** 用于恢复的备份ID，可通过[查询备份列表 - QueryingBackups](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_068.html)获取，传入和schema_type相对应的全量备份ID。当使用备份文件恢复时需要指定该参数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | restore_time | 否 | String | **参数解释：** 按时间点恢复的时间戳，时间戳获取请参见[查询可恢复时间段 - QueryingtheRestorationTimeRange](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_073.html)。 **约束限制：** 不涉及。 **取值范围：** 符合yyyy-mm-dd格式，长度为10个字符，由数字和连字符组成。 **默认取值：** 不涉及。 | 表5target字段数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | instance_id | 是 | String | **参数解释：** 恢复目标实例ID，可通过[查询备份列表 - QueryingBackups](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_068.html)获取。 - 恢复当前实例时，传入当前实例ID。 - 恢复到已有实例时，传入已有实例ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释：** 任务ID。 **取值范围：** 不涉及。 | #### 请求示例 恢复到当前实例或已有实例。 ``` POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/recovery { "source" : { "instance_id" : "5362449138da4e408dbae5152ca26640in14", "type" : "backup", "backup_id" : "cc94568cb5a54e4a8ab5dff95e64a5e0br14" }, "target" : { "instance_id" : "5362449138da4e408dbae5152ca26640in14" } } ``` #### 响应示例 恢复到当前实例或已有实例成功。 ``` { "job_id" : "a03b1b8a-b756-467c-8a49-38720c3d23ec" } ``` #### 状态码 - 正常 202 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。