1. 接口描述
接口请求域名： redis.tencentcloudapi.com 。
恢复 CRS 实例
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RestoreInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 待操作的实例ID，可通过 DescribeInstances 接口返回值中的 InstanceId 获取。 示例值：crs-5a4py64p |
| BackupId | 是 | String | 备份ID，可通过 GetRedisBackupList 接口返回值中的 backupId 获取 示例值：678362566696298532848117 |
| Password | 否 | String | 实例密码，恢复实例时，需要校验实例密码（免密实例不需要传密码） 示例值：mypassword |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 任务ID，可通过 DescribeTaskInfo 接口查询任务执行状态 示例值：6954227 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 恢复 CRS 实例
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RestoreInstance
<公共请求参数>
{
"InstanceId": "crs-5a4py64p",
"BackupId": "678362566696298532848117",
"Password": "mypassword"
}输出示例
{
"Response": {
"TaskId": "6954227",
"RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.SystemError | 内部系统错误，和业务无关。 |
| InternalError.InternalError | 内部错误。 |
| InvalidParameter.InvalidParameter | 业务参数错误。 |
| InvalidParameter.PermissionDenied | 接口没有cam权限。 |
| InvalidParameterValue.BackupNotExists | 备份不存在。 |
| InvalidParameterValue.PasswordError | 密码校验出错，密码错误。 |
| ResourceNotFound.InstanceNotExists | 根据 serialId 没有找到对应 redis。 |
| ResourceUnavailable.BackupLockedError | 备份已被其它任务锁住，暂时不能执行该操作。 |
| ResourceUnavailable.BackupSpecError | 备份还原规格不支持。 |
| ResourceUnavailable.BackupStatusAbnormal | 备份状态异常，暂不能执行该操作。备份可能已过期或已被删除。 |
| ResourceUnavailable.InstanceLockedError | redis 已经被其它流程锁定。 |
| ResourceUnavailable.InstanceStateError | 实例状态错误。 |
| ResourceUnavailable.InstanceStatusAbnormal | redis 状态异常，不能执行对应流程。 |
| UnauthorizedOperation.NoCAMAuthed | 无cam 权限。 |
