Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Backup Management/ Querying the Restoration Time Range
Updated on 2023-10-18 GMT+08:00
View PDF

Querying the Restoration Time Range

Function

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

URI

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

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 of a tenant in a project.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

date

No

String

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

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

restore_times

Array of RestoreTimeInfo objects

Restoration time ranges.
Table 5 RestoreTimeInfo

Parameter

Type

Description

start_time

Integer

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

end_time

Integer

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

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