更新时间:2024-04-01 GMT+08:00
分享

恢复到当前实例

接口说明

  • 恢复到当前实例。
  • 针对集群实例,如果当前存在只读节点,不支持恢复到当前实例,只能恢复到新实例。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

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

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/recovery

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

从IAM服务获取的用户Token。请参考认证鉴权

X-Language

string

header

语言。

project_id

string

path

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

请求消息

  • 参数说明
    表2 参数说明

    名称

    参数类型

    是否必选

    描述

    source

    Object

    恢复数据源对象。

    请参见表3

    target

    Object

    恢复目标对象。

    请参见表4

    表3 source字段数据结构说明

    名称

    参数类型

    是否必选

    描述

    instance_id

    String

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

    type

    String

    表示恢复方式,枚举值:

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

    backup_id

    String

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

    restore_time

    String

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

    说明:

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

    表4 target字段数据结构说明

    名称

    参数类型

    是否必选

    描述

    instance_id

    String

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

请求示例

  • 使用备份文件恢复,恢复目标实例ID为d8e6ca5a624745bcb546a227aa3ae1cfin02
    {
      "source": {
        "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02",
        "type": "backup",
        "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe"
      },
      "target": {
        "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02"
      }
    }
  • 根据时间点恢复(适用于副本集实例和4.0版本的集群实例),恢复目标实例ID为d8e6ca5a624745bcb546a227aa3ae1cfin02
    {
      "source": {
        "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02",
        "type": "timestamp",
        "restore_time": 1532001446987
      },
      "target": {
        "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02"
      }
    }

响应消息

  • 参数说明
    表5 参数说明

    名称

    参数类型

    是否必选

    描述

    job_id

    String

    恢复操作的异步任务ID。

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

SDK

单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码

错误码

详情请参见错误码

相关文档