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

文档中心

立即注册

导航

RestoreDBInstance

最近更新时间：2024.12.13 17:25:37首次发布时间：2024.12.13 17:25:37

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

请求类型

异步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
BackupType	String	否	Full	恢复方式。当前仅支持选择备份方式为 `Full`（即全量备份）的备份文件进行恢复，即按备份集恢复至原实例。
BackupPointId	String	是	b-cnlfs97a4tuhjxguaffl7qu8****	备份 ID，用于按备份集恢复时指定所用备份。说明您可以调用 DescribeBackups 接口查询指定实例下所有的备份信息，包括备份 ID（即返回参数中 `BackupPointId` 的参数值）。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例

按备份集恢复到原实例。

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
}

错误码

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