Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Backups and Restorations/ Restoring the Current Redis Instance to a Point in Time
Updated on 2025-09-16 GMT+08:00
View PDF
Share

Restoring the Current Redis Instance to a Point in Time

Function

This API is used to restore the current Redis instance to a point in time.

Constraints

  • This API supports only GeminiDB Redis instances in a proxy cluster.
  • Some instances of earlier versions need to be upgraded to use this API.

URI

PUT /v3/{project_id}/redis/instances/{instance_id}/pitr

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

restore_time

Yes

String

Time point to which data is restored in the yyyy-mm-ddThh:mm:ssZ format. T is the separator between calendar and hourly notation of time, and Z indicates the time zone offset.

For details, see parameter values under restore_time in Table 4.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/instances/e73893ef73754465a8bd2e0857bbf13ein12/pitr 
  
 { 
   "restore_time" : "2022-06-01T18:50:20+0800" 
 }

Example Response

Status code: 202

Success

{ 
   "job_id" : "20f793fd-2703-4339-bfb5-f1c9065b15c8" 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations