文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 备份管理> 备份恢复到当前实例或已有实例
更新时间：2024-02-27 GMT+08:00
在线调试
CLI示例
查看PDF

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

功能介绍

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

接口约束

备份恢复到已有实例时，目标实例引擎类型、版本号、表名大小写敏感要求与原实例相同。

URI

POST /v3/{project_id}/instances/restore

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

target_instance_id

是

String

目标实例ID。

source_instance_id

是

String

源实例ID。

type

是

String

表示恢复方式，枚举值：

  • backup：表示使用备份文件恢复，按照此方式恢复时，当"type"字段为非必选时，"backup_id"必选。
  • timestamp：表示按时间点恢复，按照此方式恢复时，当"type"字段必选时，"restore_time"必选。

backup_id

否

String

用于恢复的备份ID。当使用备份文件恢复时需要指定该参数。

获取方法请参见查询全量备份列表。

restore_time

否

Long

恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

工作流ID。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 按备份文件恢复到当前实例
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "backup_id" : "7ffbf305376b4cbea0ae491257b6aaf9br07",
  "type" : "backup"
}
  • 按时间点恢复到当前实例
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "restore_time" : 1673852043000,
  "type" : "timestamp"
}
  • 按备份文件恢复到已有实例
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "backup_id" : "be4ddfd7e2b94640b5e2cb44efb30b22br07",
  "type" : "backup"
}
  • 按时间点恢复到已有实例
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "restore_time" : 1673852043000,
  "type" : "timestamp"
}

响应示例

状态码： 200

Success.

{
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份管理