Querying Instances that Can Be Restored

Function

This API is used to query all instances that can be restored.

Constraints

This API supports only GeminiDB Mongo instances.

URI

GET https://{Endpoint}/v3/{project_id}/backups/{backup_id}/restorable-instances

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a user in a region. To obtain this value, see Obtaining a Project ID.
backup_id	Yes	String	Backup file ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Index offset. The value must be no less than 0. If this parameter is not transferred, the index offset is 0 by default.
limit	No	Integer	Maximum instances that can be restored. The value ranges from 1 to 100. If this parameter is not transferred, the first 100 records are queried by default.

Request Parameters

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Total number of instances that can be restored.
restorable_instances	Array of QueryRestoreList objects	Information about the instances that can be restored.

**Table 5** QueryRestoreList
Parameter	Type	Description
instance_id	String	Instance ID.
instance_mode	String	Instance type.
engine_name	String	API name.
engine_version	String	API version.
vpc_id	String	VPC ID.
subnet_ids	Array of strings	Subnet IDs.
security_group_ids	Array of strings	Security group IDs.

Example Requests

URI example

GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/backups/2b19a3348108411baf7c46cf8d668e90br10/restorable-instances?offset=0&limit=100

Example Responses

Status code: 200

Success

{
  "total_count" : 1,
  "restorable_instances" : [ {
    "instance_id" : "6aef2786115341b6a18a67e0ee6ef664in10",
    "instance_mode" : "ReplicaSet",
    "engine_name" : "geminimongodb",
    "engine_version" : "4.0.3.11",
    "vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
    "subnet_ids" : [ "f1df08c5-71d1-406a-aff0-de435a51007" ],
    "security_group_ids" : [ "7aa51dbf-5b63-40db-9724-dad3c4828b58" ]
  } ]
}