Help Center/ GeminiDB/ API Reference/ API v3/ Backups and Restorations/ Querying the Point in Time to Which a GeminiDB Redis Instance Can Be Restored
Updated on 2026-09-22 GMT+08:00
View PDF
Share

Querying the Point in Time to Which a GeminiDB Redis Instance Can Be Restored

Function

This API is used to query the point in time to which a GeminiDB Redis instance can be restored.

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:listRedisPitrRestoreTime

    List

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

    nosql:instance:listRedisPitrRestoreTime

    -

URI

GET /v3/{project_id}/redis/instances/{instance_id}/pitr/restorable-time-periods

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
Table 2 Query parameters

Parameter

Mandatory

Type

Description

start_time

Yes

String

Definition

Start time of the PITR time range. The format is yyyy-mm-ddThh:mm:ssZ. T indicates the start time, and Z indicates the time zone offset.

Constraints

N/A

Range

N/A

Default Value

N/A

end_time

Yes

String

Definition

End time of the PITR time range. The format is yyyy-mm-ddThh:mm:ssZ. T indicates the start time, and Z indicates the time zone offset.

Constraints

N/A

Range

N/A

Default Value

N/A

offset

No

Integer

Definition

Offset. The records after this offset will be queried.

Constraints

N/A

Range

N/A

Default Value

0

limit

No

Integer

Definition

Maximum number of records that can be returned.

Constraints

N/A

Range

1–300

Default Value

300

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

restore_time

Array of strings

Definition

Points in time that a GeminiDB Redis instance can be restored to. The value is in the yyyy-mm-ddThh:mm:ssZ format, where T is the separator between the calendar and the hourly notation of time, and Z indicates the time zone offset.

total_count

Integer

Definition

Total points in time that a GeminiDB Redis instance can be restored to.

Range

N/A

Example Requests

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/instances/e73893ef73754465a8bd2e0857bbf13ein12/pitr/restorable-time-periods?start_time=2022-06-01T18:50:20+0800&end_time=2022-06-01T19:50:20+0800&offset=0&limit=100

Example Responses

Status code: 200

Success

{ 
   "total_count": 2, 
   "restore_time": [ 
        "2022-06-01T18:50:20+0800", 
        "2022-06-01T18:55:20+0800" 
   ]
 }

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations