文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/备份与恢复/恢复到当前实例
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

恢复到当前实例

接口说明

  • 恢复到当前实例。

URI

  • URI格式

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

表1 路径参数

名称

类型

IN

是否必选

描述

X-Language

string

header

否

语言。

project_id

string

path

是

项目ID。请参考获取项目ID章节获取项目编号。

请求参数

表2 请求Header参数

名称

类型

是否必选

描述

X-Auth-Token

String

是

用户Token。

表3 参数说明

名称

参数类型

是否必选

描述

source

Object

是

恢复数据源对象。

请参见表4。

target

Object

是

恢复目标对象。

请参见表5。

表4 source字段数据结构说明

名称

参数类型

是否必选

描述

instance_id

String

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

type

String

否

表示恢复方式，枚举值：

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

backup_id

String

否

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

restore_time

String

否

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

说明：

目前该参数只适用于副本集实例。

表5 target字段数据结构说明

名称

参数类型

是否必选

描述

instance_id

String

是

恢复目标实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

  • 请求示例
    • 使用备份文件恢复 
      {
  "source": {
    "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02",
    "type": "backup",
    "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe"
  },
  "target": {
    "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02"
  }
}
    • 根据时间点恢复（适用于4.0、4.2、4.4版本的副本集实例和4.0、4.2、4.4版本的集群实例） 
      {
  "source": {
    "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02",
    "type": "timestamp",
    "restore_time": 1532001446987
  },
  "target": {
    "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02"
  }
}

响应参数

表6 参数说明

名称

参数类型

是否必选

描述

job_id

String

是

恢复操作的异步任务ID。

  • 响应示例 
    {
    "job_id": "a03b1b8a-b756-467c-8a49-38720c3d23ec"
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：备份与恢复