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.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:listRestorableInstances	List	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:list	-

URI

GET /v3/{project_id}/backups/{backup_id}/restorable-instances

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

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

Request Parameters

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

Response Parameters

Status code: 200

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

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

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

Successful response

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