Help Center/ GeminiDB/ API Reference/ API v3/ Backups and Restorations/ Setting the Policy for Restoring a GeminiDB Redis Instance to a Specified Point in Time
Updated on 2026-09-22 GMT+08:00
View PDF
Share

Setting the Policy for Restoring a GeminiDB Redis Instance to a Specified Point in Time

Function

This API is used to set the policy for restoring a GeminiDB Redis instance to a specified point in time.

Constraints

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

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:setRedisPitrPolicy

    write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:setRedisPitrPolicy

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

enabled

Yes

Boolean

Definition

Whether point-in-time recovery (PITR) is enabled for a GeminiDB Redis instance.

Constraints

N/A

Range

  • true: PITR is enabled for the instance.
  • false: PITR is disabled for the instance.

Default Value

N/A

interval

No

Integer

Definition

Interval for backing up data. This parameter specifies the interval for restoring Redis instances to a specified point in time.

If interval is set to 20 minutes, the interval for restoring data to a specified point in time is 20 minutes. Shorter intervals may affect performance and demand additional storage.

Constraints

N/A

Range

5–120 (unit: minute)

Default Value

20 minutes

keep_days

No

Integer

Definition

Backup retention days.

Constraints

N/A

Range

1–7 (unit: day)

Default Value

1 day

Response Parameters

Status code: 200

No response parameters

Example Requests

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/instances/e73893ef73754465a8bd2e0857bbf13ein12/pitr/policy 
  
 { 
   "enabled" : true, 
   "interval" : 20, 
   "keep_days" : 7 
 }

Example Responses

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations