调用RestoreInstance API从备份文件或时间点恢复数据-云数据库 Tair（兼容 Redis®）-阿里云-云数据库 Tair（兼容 Redis®）(Tair)-阿里云帮助中心

接口说明

当您的实例为经典架构 Tair（企业版）内存型，您可以调用本接口将指定 Key 在当前实例中恢复至某个秒级时间点，可实现更精细化的数据恢复。
除上述以外的实例，推荐调用 CreateInstance 或 CreateTairInstance 接口，将备份数据恢复至新实例中。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

kvstore:RestoreInstance

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	r-bp1zxszhcgatnx****
BackupId	string	否	实例的备份文件 ID。您可以调用 DescribeBackups 查询。	78241****
RestoreType	string	否	恢复类型，取值： 0（默认）：参数已失效。 1：恢复至指定的时间点，仅当实例开启了数据闪回功能时，您才可以传入该值。传入为该值时，您还需要传入 RestoreTime 参数。	1
RestoreTime	string	否	要恢复的时间点，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。说明该时间点不能早于开启数据闪回功能的时间点。	2021-07-06T07:25:57Z
FilterKey	string	否	指定要恢复的 Key，支持正则表达式，多个值使用英文逗号（,）分隔。当不传入该参数时，表示恢复整个实例。当传入该参数时，表示仅恢复相关 Key。且仅经典版实例支持该功能。说明例如正则表达式中，星号（``）表示匹配前面子表达式任意次，本参数传入`h.llo`，系统将匹配`hllo`或`heeeello`等字符串。	key:00000007198*
TimeShift	string	否	当恢复经典版实例时，不论您选择恢复全量数据或指定 Key，您都可以对 Key 的过期时间进行偏移处理。格式为 yyyy-MM-ddTHH:mmZ（UTC 时间）。实例会将 Key 在指定闪回时间点所剩余的过期时长，偏移至设置的过期偏移时间点开始计算。说明该功能仅支持偏移 Key 级别的过期时间，不支持偏移 Tair 自研数据结构中 Key 内部的过期时间，例如 exHash 的 Field、TS 的 Skey 等。该时间点不能早于指定的闪回时间点，也不能晚于提交恢复任务的时间点。	2021-07-06T08:25:57Z

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	8D0C0AFC-E9CD-47A4-8395-5C31BF9B****

示例

正常返回示例

JSON格式

{
  "RequestId": "8D0C0AFC-E9CD-47A4-8395-5C31BF9B****"
}

异常返回示例

JSON格式

{
"RequestId" : "AFA391BF-808F-4DA6-80A2-A382108A0945"
}

错误码

HTTP status code	错误码	错误信息
400	ServiceNotSupport	This service not supported.
400	MissingParameter	Missing Required Param: BackupId or RestoreTime or RestoreType.
400	ResroreParamNotMatch	restoreType is not match with backupId or restoreTime.
400	InvalidRestoreTime.Format	Specified restore time is not valid.
400	ZoneMigrationError.StillingRunning	Zone migration task is still running
400	InvalidBinlog.NotValid	The available binlog is not valid in recovery time.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。