Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Backup Management/ Querying the Restoration Time Range

Updated on 2025-05-22 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:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

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, which is compliant with the UUID format.

**Table 2** Query parameter
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	Explanation: 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: None Value range: None Default value: None
X-Language	No	String	Explanation: Request language type. Constraints: None Value 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	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

Previous topic: Restoring Data to the Original Instance or an Existing Instance

Next topic: Enabling or Disabling Encrypted Backup

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot