文档首页> 云数据库 GaussDB> API参考> API（推荐）> 备份恢复管理> 查询可用于备份恢复的实例列表
更新时间：2024-05-20 GMT+08:00
查看PDF
分享

查询可用于备份恢复的实例列表

功能介绍

查询可用于备份恢复的实例列表，实例信息要符合备份条件。

接口约束

restore_time和backup_id参数不能同时为空。

调试

您可以在API Explorer中调试该接口。

URI

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

表1 参数说明

名称

是否必选

说明

project_id

是

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

source_instance_id

是

源实例ID，需要恢复的实例ID。

backup_id

否

实例备份信息ID，根据备份ID查询实例拓扑信息，过滤查询出来的实例，包含节点数，副本数等。参数为空时，根据restore_time查询。

restore_time

否

恢复点，当备份ID为空时，通过此参数查询实例拓扑信息，过滤实例列表。

offset

否

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

limit

否

查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

请求参数

无

响应参数

表2 参数说明

名称

参数类型

说明

instances

Array of Objects

返回可用于备份恢复的实例列表。

详情请参见instances参数数据结构说明。

total_count

Integer

查询出来的实例总数。
表3 instances参数数据结构说明

名称

参数类型

说明

instance_name

String

实例名称。

instance_id

String

实例ID。

volume_type

String

存储类型。

data_volume_size

Number

磁盘大小，单位：GB。

version

Number

实例版本信息。

mode

String

部署形态。

  • Ha：主备版。
  • Independent：独立部署。

instance_mode

String

实例模型。

  • enterprise：企业版。
  • standard：标准版。
  • basic：基础版。

请求示例

查询可用于备份恢复的实例列表。

GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/restorable-instances?source_instance_id=88efb3753dc844829c380edff7798eecin14&backup_id=d3f223e9c35d450ea0692bdbff686e45br14

响应示例

查询可用于备份恢复的实例列表成功。

{ 
  "instances" : [ { 
    "instance_name" : "gaussdb_hzx", 
    "instance_id" : "3ea6d6463c9a4baf9a47c5b74464307cin14", 
    "volume_type" : "ULTRAHIGH", 
    "data_volume_size" : 500, 
    "version" : 1.3, 
    "mode" : "Ha", 
    "instance_mode" : "enterprise" 
  } ], 
  "total_count" : 1 
}

状态码

错误码

请参见错误码。

父主题： 备份恢复管理
分享：

    相关文档

    相关产品