Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Backups and Restorations/ Querying the Restoration Time Range of a Redis Instance
Updated on 2025-11-27 GMT+08:00
View PDF
Share

Querying the Restoration Time Range of a Redis Instance

Function

This API is used to query the restoration time range of a Redis instance.

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.

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

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

instance_id

Yes

String

Instance ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

start_time

Yes

String

Start time point that the backup can be restored to. The time point is 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.

end_time

Yes

String

End time point that the backup can be restored to. The time point is 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.

offset

No

Integer

Offset. The records after this offset will be queried. The default value is 0.

limit

No

Integer

Maximum number of records displayed on each page. The value ranges from 0 to 100. The default value is 300.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

restore_time

Array of strings

Time points that the Redis backup can be restored to. The time point is 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.

total_count

Integer

Total time points that a Redis backup can be restored to.

Status code: 400

Table 5 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/restorable-time-periods?start_time=2022-06-01T18:50:20+0800&end_time=2022-06-01T19:50:20+0800&offset=0&limit=100

Example Response

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