华为云云数据库GaussDB查询可用于备份恢复的实例列表_云淘科技
功能介绍
查询可用于备份恢复的实例列表,实例信息要符合备份条件。
调用接口前,您需要了解API 认证鉴权。
调用接口前,您需要提前获取到地区和终端节点,即下文中的Endpoint值。
调试
您可以在API Explorer中调试该接口。
URI
URI格式
GET https://{Endpoint}/v3/{project_id}/restorable-instances
URI样例
https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/restorable-instances?source_instance_id=88efb3753dc844829c380edff7798eecin14&backup_id=d3f223e9c35d450ea0692bdbff686e45br14
参数说明
名称 |
是否必选 |
说明 |
---|---|---|
project_id |
是 |
租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 |
source_instance_id |
是 |
源实例ID,需要恢复的实例ID。 |
backup_id |
否 |
实例备份信息ID,根据备份ID查询实例拓扑信息,过滤查询出来的实例,包含节点数,副本数等。参数为空时,根据restore_time查询。 |
restore_time |
否 |
恢复点,当备份ID为空时,通过此参数查询实例拓扑信息,过滤实例列表。 |
offset |
否 |
索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 |
limit |
否 |
查询记录数。默认为100,不能为负数,最小值为1,最大值为100。 |
请求消息
无
响应消息
正常响应要素说明
名称 |
参数类型 |
说明 |
---|---|---|
instances |
Array of Objects |
返回可用于备份恢复的实例列表。 详情请参见instances参数数据结构说明。 |
total_count |
Integer |
查询出来的实例总数。 |
名称 |
参数类型 |
说明 |
---|---|---|
instance_name |
String |
实例名称。 |
instance_id |
String |
实例id。 |
volume_type |
String |
存储类型。 |
data_volume_size |
Number |
磁盘大小,单位:GB。 |
version |
Number |
实例版本信息。 |
mode |
String |
部署形态。 Ha:主备版 |
instance_mode |
String |
实例模型。 enterprise:企业版 |
正常响应样例
{ "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 }
异常响应
请参见异常请求结果。
状态码
正常
200
异常
请参见状态码。
错误码
请参见错误码。
父主题: 备份管理
同意关联代理商云淘科技,购买华为云产品更优惠(QQ 78315851)
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家