Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Backups and Restorations/ Querying the Time Window When a Backup Can Be Restored
Updated on 2025-10-17 GMT+08:00
View PDF
Share

Querying the Time Window When a Backup Can Be Restored

Function

This API is used to query the time window when a backup can be restored.

Constraints

This API supports the following types of instances:

  • GeminiDB Cassandra
  • GeminiDB Influx

This API does not support single-node GeminiDB Influx instances.

Make sure that full backup, incremental backup, and automated backup have been enabled. To enable incremental backup, contact customer service. This function can be used only when the next automated backup is performed.

This API can be used to query the time point that a backup can be restored to, so values of start_time and end_time are the same.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

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

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID, which can be obtained by following Querying Instances and Details. If there are no instances available, call the API described in Creating an Instance to create one.

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

start_time

No

String

Explanation:

Start time point that the backup can be restored to. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time, and Z indicates the time zone offset.

Constraints:

N/A

Values:

N/A

Default value:

The day before the current query time

end_time

No

String

Explanation:

End time point that the backup can be restored to. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time, and Z indicates the time zone offset.

Constraints:

N/A

Values:

N/A

Default value:

The current query time

offset

No

Integer

Explanation:

Offset. The records after this offset will be queried.

Constraints:

N/A

Values:

N/A

Default value:

0

limit

No

Integer

Explanation:

Maximum number of records that can be returned

Constraints:

N/A

Values:

0–1000

Default value:

1000

Request Parameters

Table 3 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

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

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Explanation:

Time windows when a backup can be restored

Values:

N/A

restorable_time_periods

Array of restorableTime objects

Explanation:

Time window when a backup can be restored

Values:

N/A
Table 5 restorableTime

Parameter

Type

Description

start_time

Long

Explanation:

Restoration start time in the UNIX format (UTC time in milliseconds)

Values:

N/A

end_time

Long

Explanation:

Restoration end time in the UNIX format (UTC time in milliseconds)

Values:

N/A

Example Request

  • URI example 
    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups/restorable-time-periods?start_time=2022-06-01T18:50:20+0800&end_time=2022-06-01T19:50:20+0800&offset=0&limit=1000

Example Response

Status code: 200

Success

{
  "total_count" : 1,
  "restorable_time_periods" : [ {
    "start_time" : 1607731200000,
    "end_time" : 1607731200000
  } ]
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations