Obtaining the List of Databases That Can Be Restored

This API is used to obtain the list of databases that can be restored.

This API applies only to replica sets.

URI format
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-database?restore_time={restore_time}&offset={offset}&limit={limit}

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
X-Language	String	No	Language
project_id	String	Yes	Project ID. To obtain the project ID, see Obtaining a Project ID.
instance_id	String	Yes	Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.
restore_time	String	Yes	Specifies the restoration time point. The value is a UNIX timestamp, in milliseconds. The time zone is UTC.
offset	Integer	No	Specifies the index position. The value must be greater than or equal to 0. If this parameter is not transferred, the value is 0 by default.
limit	Integer	No	Specifies the upper limit of the number of queried records. The value ranges from 1 to 100. If this parameter is not transferred, the first 100 records are queried by default.

**Table 2** Request header parameters
Parameter	Type	Mandatory	Description
X-Auth-Token	String	Yes	User token

**Table 3** Parameter description
Parameter	Type	Mandatory	Description
databases	Array of String	Yes	Indicates the database list. Each element in the list indicates a database.
total_count	Integer	Yes	Indicates the total number of databases.

Example response

{
  "databases": [
    "test_db"
  ],
  "total_count": 1
}

For details, see Status Code.

For details, see Error Code.

Parent topic: Backup and Restoration

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.