Contents：
1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to restore a Redis instance.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: RestoreInstance |
| Version | Yes | String | Common parameter. The value used for this API: 2018-04-12 |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | ID of the instance to be operated on, which can be obtained through the redisId field in the return value of the DescribeRedis API. |
| BackupId | Yes | String | Backup ID, which can be obtained through the backupId field in the return value of the GetRedisBackupList API |
| Password | No | String | Instance password, which needs to be validated during instance restoration (this parameter is not required for password-free instances) |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | Integer | Task ID, which can be used to query the task execution status through the DescribeTaskInfo API |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Restoring a Redis Instance
Input Example
https://redis.tencentcloudapi.com/?Action=RestoreInstance
&InstanceId=crs-5a4py64p
&Password=mypassword
&BackupId=678362566696298532848117
&<Common request parameter>Output Example
{
"Response": {
"TaskId": "6954227",
"RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"
}
}5. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.InternalError | Internal error. |
| InvalidParameter.InvalidParameter | Invalid service parameter. |
| InvalidParameter.PermissionDenied | The API has no CAM permissions. |
| InvalidParameterValue.BackupNotExists | The backup does not exist. |
| InvalidParameterValue.PasswordError | Password verification error due to incorrect password. |
| ResourceNotFound.InstanceNotExists | No Redis instance is found by the serialId. |
| ResourceUnavailable.BackupLockedError | The backup has been locked by another task, and the operation cannot be performed temporarily. |
| ResourceUnavailable.BackupStatusAbnormal | Backup status exception. The operation cannot be performed temporarily. The backup may have expired or been deleted. |
| ResourceUnavailable.InstanceLockedError | Redis has been locked by another process. |
| ResourceUnavailable.InstanceStatusAbnormal | The Redis status is exceptional, and the corresponding process cannot be executed. |
| UnauthorizedOperation.NoCAMAuthed | No CAM permissions. |
