Call the RestoreDBInstance API to restore the data in a backup set to the original Redis instance.

Request type

Asynchronous request.

Precautions

Only primary-secondary instances (i.e., where InstanceClass is PrimarySecondary) support calling this API. Single node instances (i.e., where InstanceClass is Standalone) do not support backup and recovery operations and cannot call this API. For details about the feature differences between the two instance types, refer to Feature differences.

After enabling data flashback, restoring to the original instance results in automatic shut-off and restart of data flashback. After enabling data flashback again, recoverable point in times start from the time when the original instance is restored. For more details, refer to Setting data flashback.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameters	Type	Required	Example	Description
InstanceId	String	Yes	redis-cn0212gzmh2xs1111	Instance ID. tip You can call the DescribeDBInstances API to query the basic information of all Redis instances in the target region, including the instance ID.
BackupType	String	No	Full	Restore method. Valid values: Full (default): Select a backup file with backup type Full (i.e., full backup) for recovery, restoring from the backup set. Inc: Select a backup file with backup type Inc (i.e., incremental backup) for recovery, meaning point-in-time recovery. tip If you need to restore by point in time (i.e., BackupType is Inc), you must first turn on the Data flashback feature. For more details, see Restore to original instance by point in time. You can call the StartContinuousBackup API to turn on the Data flashback feature for the specified instance.
TimePoint	String	No	2021-11-09T06:07:26Z	Used to specify the point in time for point-in-time recovery, in the format yyyy-MM-ddTHH:mm:ssZ (UTC). tip This parameter is required when selecting to restore by point-in-time (i.e., when BackupType is Inc). You can call the DescribePitrTimeWindow API to query the supported recoverable time range for a specified instance.
BackupPointId	String	No	b-cnlfs97a4tuhjxguaffl7qu81111	Backup ID, used to specify the backup when restoring by backup set. tip This parameter is required when selecting to restore by backup set (i.e., when BackupType is Full). You can call the DescribeBackups API to query all backup information for the specified instance, including the backup ID (i.e., the value of BackupPointId in the returned parameters).
ClientToken	String	No	WbiAlPqJM6tMoSOYhT****	To ensure the idempotence of requests and prevent duplicate submission of requests. The client generates the parameter values to ensure the uniqueness among different requests. Values are case-sensitive, no more than 127 ASCII characters.

Response parameters

The current API has no specified response parameters. For more information, see Response structure.

Example

Request example

Response example

Request example

Response example

Error code

For more details, see Error code.

Cache for Redis