You need to enable JavaScript to run this app.
导航
RestoreDBInstance
最近更新时间:2024.02.07 12:41:52首次发布时间:2021.11.15 16:07:17

调用 RestoreDBInstance 接口将备份集中的数据恢复到原 Redis 实例。

请求类型

异步请求。

注意事项

  • 仅主备实例支持调用该接口,单节点实例不支持备份恢复相关操作,不支持调用该接口。关于两种类型实例的功能特性差异详情,请参见功能特性差异
  • 开启数据闪回后,执行恢复到原实例操作会导致数据闪回功能先自动关闭再重新打开。数据闪回功能重新开启后,可恢复的时间点将以完成恢复到原实例操作的时间点为起点。更多详情,请参见设置数据闪回功能

请求参数

名称类型是否必选示例值描述

InstanceId

String

redis-cn0212gzmh2xs****

原实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。

BackupType

String

Full

恢复方式。取值范围如下:

  • Full(默认值):全量恢复,即按备份集恢复。
  • Inc:增量恢复,即按时间点恢复。

说明

TimePoint

String

2024-01-25T12:54:00Z

用于指定按时间点恢复时所需要恢复的时间点,格式为 yyyy-MM-ddTHH:mmZ(UTC 时间)。

说明

  • 当选择按时间点恢复(即 BackupTypeInc)时,该参数必填。
  • 您可以调用 DescribePitrTimeWindow 接口查询指定实例所支持的可恢复时间段。

BackupPointId

String

b-cnlfs97a4tuhjxguaffl7qu8****

备份 ID,用于按备份集恢复时指定所用备份。

说明

  • 当选择按备份集恢复(即 BackupTypeFull)时,该参数必填。
  • 您可以调用 DescribeBackups 接口查询指定实例下所有的备份信息,包括备份 ID(即返回参数中 BackupPointId 的参数值)。
ClientTokenStringWbiAlPqJM6tMoSOYhT****用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。

返回数据

null

请求示例

  • 按时间点恢复
POST https://redis.volcengineapi.com/?Action=RestoreDBInstance&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
	"InstanceId": "redis-cn0212gzmh2xs****",
	"TimePoint": "2024-01-25T12:54:00Z",
	"BackupType": "Inc"
}
  • 按备份集恢复
POST https://redis.volcengineapi.com/?Action=RestoreDBInstance&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
	"InstanceId": "redis-cn0212gzmh2xs****",
	"BackupType": "Full",
	 "BackupPointId": "b-cnlfs97a4tuhjxguaffl7qu8****"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202204151756080102120451971663****",
        "Action": "RestoreDBInstance",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情,请参见错误码