Help Center/ GeminiDB/ API Reference/ API v3/ Backups and Restorations/ Querying 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

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

Function

This API is used to query 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:getRedisPitrPolicy

    read

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

    nosql:instance:getRedisPitrPolicy

    -

URI

GET /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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

enabled

Boolean

Definition

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

Range

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

interval

Integer

Definition

Interval for backing up data, in minutes. This parameter specifies the interval for restoring Redis instances to a specified point in time. This parameter is returned only when the preceding function is enabled.

Range

N/A

keep_days

Integer

Definition

Days to retain the generated backups. This parameter is returned only when the preceding function is enabled.

Range

N/A

Example Requests

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

Example Responses

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