云数据库 Redis® 恢复 Redis 实例-API 文档-文档中心-腾讯云

1. 接口描述

本接口（RestoreInstance）用于恢复 Redis 实例。
接口请求域名：redis.api.qcloud.com
目标实例只能恢复到自身的备份，不能恢复到别的实例的备份。

2. 输入参数

以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，见公共请求参数页面。其中，此接口的 Action 字段为 RestoreInstance。

参数名称	是否必选	类型	描述
redisId	是	String	待操作的实例 ID，可通过 DescribeRedis 接口返回值中的 redisId 获取
password	是	String	实例密码，恢复实例时，需要校验实例密码
backupId	是	String	备份 ID，可通过 GetRedisBackupList 接口返回值中的 backupId 获取

3. 输出参数

参数名称	类型	描述
code	Int	公共错误码，0表示成功，其他值表示失败。详见错误码页面的公共错误码
message	String	错误信息描述，成功时，该值为空
codeDesc	String	业务侧错误码英文描述。成功时返回Success，错误时返回具体业务错误原因
data	Object	任务ID

其中，data 表示任务ID，其参数构成如下：

参数名称	类型	描述
data.requestId	任务ID	任务ID，可通过 DescribeTaskInfo 接口查询任务执行状态

4. 错误码

以下错误码表列出了该接口的业务逻辑错误码。

错误代码	英文提示	错误描述
11201	InvalidParameter	业务参数错误
10701	InstanceNotExists	没有找到serialId对应的实例
10707	InstanceLockedError	实例已被锁住，暂时不能执行该操作
10702	InstanceStatusAbnormal	实例状态异常,暂时不能执行该操作（例如，流程中或已隔离或已删除）
10711	BackupStatusAbnormal	备份状态异常，暂不能执行该操作。备份可能已过期或已被删除
10710	BackupLockedError	备份已被其它任务锁住，暂时不能执行该操作
10712	PasswordError	实例密码错误
11213	BackupNotExists	根据 backupId，没有找到实例对应的备份

5. 示例

https://redis.api.qcloud.com/v2/index.php?Action=RestoreInstance
&<公共请求参数>
&redisId=crs-izbob1wh
&password=12D3E@!r5ed
&backupId=e824aecc-ef5e-11e6-a2c7-525400082493

返回示例如下：

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "requestId": 375074
    }
}

恢复 Redis 实例

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 错误码

5. 示例