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

Querying the Storage Space Used for Restoring a Redis Instance to a Specified Time Point

Function

This API is used to query the storage space used for restoring a Redis instance 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

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

storage

String

Storage space required to restore a Redis instance to a specified time point. Unit: GB

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

Example Response

Status code: 200

Success

{ 
   "storage" : "10" 
 }

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations