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 /v3/{project_id}/backups/{backup_id}/restorable-instances

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a user in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A
backup_id	Yes	String	Explanation: Backup file ID Constraints: N/A Values: N/A Default value: N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Explanation: Index offset Constraints: The value must be greater than or equal to 0. Values: N/A Default value: 0
limit	No	Integer	Explanation: Maximum records to be queried Constraints: N/A Values: 1–100 Default value: 100

Request Parameters

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Explanation: User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints: N/A Values: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Explanation: Total number of instances that can be restored Values: N/A
restorable_instances	Array of QueryRestoreList objects	Explanation: Information about the instances that can be restored Values: N/A

**Table 5** QueryRestoreList
Parameter	Type	Description
instance_id	String	Explanation: Instance ID Values: N/A
instance_mode	String	Explanation: Instance mode Values: N/A
engine_name	String	Explanation: API name Values: N/A
engine_version	String	Explanation: API version Values: N/A
vpc_id	String	Explanation: VPC ID Values: N/A
subnet_ids	Array of strings	Explanation: Subnet IDs Values: N/A
security_group_ids	Array of strings	Explanation: Security group IDs Values: N/A

Example Request

URI example

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

Example Response

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" ]
  } ]
}