Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Backup Management/ Querying the Restoration Time Range
Updated on 2025-10-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Restoration Time Range

Function

This API is used to query the restoration time range of an instance. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • 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

    Dependency

    gaussdbformysql:backup:getRestoreTime

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:list
    • gaussdb:backup:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/restore-time

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, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A
Table 2 Query parameter

Parameter

Mandatory

Type

Description

date

No

String

Definition

Date to be queried.

Constraints

N/A

Range

The value is in the "yyyy-mm-dd" format, and the time zone is UTC.

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

restore_times

Array of RestoreTimeInfo objects

Definition

Restoration time ranges.
Table 5 RestoreTimeInfo

Parameter

Type

Description

start_time

Integer

Definition

Start time of the restoration time range in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.

Range

N/A

end_time

Integer

Definition

End time of the restoration time range in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying the restoration time range of the DB instance on January 31, 2023

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/restore-time?date=2023-01-31

Example Response

Status code: 200

Success.

{
  "restore_times" : [ {
    "start_time" : 1675149246000,
    "end_time" : 1675094400000
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management