RestoreDBInstance--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

RestoreDBInstance

最近更新时间：2024.12.10 22:14:56首次发布时间：2021.11.15 16:07:17

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

请求类型

异步请求。

注意事项

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

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
BackupType	String	否	Full	恢复方式。取值范围如下： `Full`（默认值）：选择备份方式为 `Full`（即全量备份）的备份文件进行恢复，即按备份集恢复。 `Inc`：选择备份方式为 `Inc`（即增量备份）的备份文件进行恢复，即按时间点恢复。说明若需要按时间点恢复（即 `BackupType` 为 `Inc` ），需先开启数据闪回功能。更多详情，请参见按时间点恢复到原实例。您可以调用 StartContinuousBackup 接口为指定实例开启数据闪回功能。
TimePoint	String	否	2021-11-09T06:07:26Z	用于指定按时间点恢复时所需要恢复的时间点，格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC）。说明当选择按时间点恢复（即 `BackupType` 为 `Inc`）时，该参数必填。您可以调用 DescribePitrTimeWindow 接口查询指定实例所支持的可恢复时间段。
BackupPointId	String	否	b-cnlfs97a4tuhjxguaffl7qu8****	备份 ID，用于按备份集恢复时指定所用备份。说明当选择按备份集恢复（即 `BackupType` 为 `Full`）时，该参数必填。您可以调用 DescribeBackups 接口查询指定实例下所有的备份信息，包括备份 ID（即返回参数中 `BackupPointId` 的参数值）。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例 1

按时间点恢复到原实例。

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": "2021-11-09T14:07:26Z"
}

返回示例 1

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

请求示例 2

按备份集恢复到原实例。

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****"
}

返回示例 2

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

错误码

更多详情，请参见错误码。