文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 备份恢复管理/ 恢复到当前实例或已有实例
更新时间：2024-08-20 GMT+08:00
查看PDF
分享

恢复到当前实例或已有实例

功能介绍

将数据库恢复到当前实例或已有实例。

URI

POST https://{endpoint}/v3/{project_id}/instances/recovery

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

请求参数

表2 参数说明

参数

是否必选

参数类型

描述

source

是

Object

恢复数据源对象。详情见表3

target

是

Object

恢复目标对象。详情见表4
表3 source 字段数据结构说明

参数

是否必选

参数类型

描述

instance_id

是

String

实例ID。

type

是

String

表示恢复方式，缺省值为backup，枚举值：

  • backup：表示使用备份文件恢复，按照此方式恢复时，“backup_id”必选。
  • timestamp：表示按时间点恢复，按照此方式恢复时，“restore_time”必选。

backup_id

否

String

用于恢复的备份ID，传入和schema_type相对应的全量备份ID。当使用备份文件恢复时需要指定该参数。

restore_time

否

String

按时间点恢复的时间戳，时间戳获取请参见查询可恢复时间段。
表4 target字段数据结构说明

参数

是否必选

参数类型

描述

instance_id

是

String

恢复目标实例ID。

  • 恢复当前实例时，传入当前实例ID。
  • 恢复到已有实例时，传入已有实例ID。

响应参数

表5 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

请求示例

恢复到当前实例或已有实例。

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/recovery
{ 
   "source" : { 
     "instance_id" : "5362449138da4e408dbae5152ca26640in14", 
     "type" : "backup", 
     "backup_id" : "cc94568cb5a54e4a8ab5dff95e64a5e0br14"
   }, 
   "target" : { 
     "instance_id" : "5362449138da4e408dbae5152ca26640in14" 
   } 
 }

响应示例

恢复到当前实例或已有实例成功。

{ 
  "job_id" : "a03b1b8a-b756-467c-8a49-38720c3d23ec" 
}

状态码

错误码

请参见错误码。

父主题： 备份恢复管理