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

Querying the Policy for Restoring Redis Data to a Specified Time Point

Function

This API is used to query the policy for restoring Redis data to a specified time point.

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

GET /v3/{project_id}/redis/instances/{instance_id}/pitr/policy

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

enabled

Boolean

Specifies whether to enable point-in-time restoration for a Redis instance.

  • true: indicates that the point-in-time restoration is enabled for the instance.
  • false: indicates that the point-in-time restoration is disabled for the instance.

interval

Integer

Interval for backing up data. This parameter is returned only when restoring Redis data to a specified time point is enabled.

keep_days

Integer

Days to retain the generated backups. This parameter is returned only when restoring Redis data to a specified time point is enabled.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/instances/e73893ef73754465a8bd2e0857bbf13ein12/pitr/policy

Example Response

Status code: 200

Success

{ 
   "enabled" : true, 
   "interval" : 20, 
   "keep_days" : 7 
 }

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations