文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 备份与恢复/ 查询可恢复的实例列表
更新时间：2023-11-21 GMT+08:00
查看PDF
分享

查询可恢复的实例列表

功能介绍

查询用户可恢复的实例列表。

接口约束

该接口只支持GeminiDB Mongo数据库实例。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户在某一region下的project ID。获取方法请参见获取项目ID。

backup_id

是

String

备份文件ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

索引位置偏移量。取值大于或等于0。不传该参数时，查询偏移量默认为0。

limit

否

Integer

查询个数上限值。取值范围：1~100。不传该参数时，默认查询前100条信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

可恢复的实例总数。

restorable_instances

Array of QueryRestoreList objects

可恢复的实例信息。
表5 QueryRestoreList

参数

参数类型

描述

instance_id

String

实例ID。

instance_mode

String

实例模式。

engine_name

String

接口名称。

engine_version

String

接口版本。

vpc_id

String

VPC ID。

subnet_ids

Array of strings

子网ID列表。

security_group_ids

Array of strings

安全组ID列表。

请求示例

URI样例 
GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/backups/2b19a3348108411baf7c46cf8d668e90br10/restorable-instances?offset=0&limit=100

响应示例

状态码： 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" ]
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份与恢复

相关文档