查询可用于备份恢复的实例列表
接口约束
restore_time和backup_id参数不能同时为空。
调试
您可以在API Explorer中调试该接口。
URI
GET /v3.1/{project_id}/restorable-instances
| 
        名称  | 
      
        是否必选  | 
      
        说明  | 
     
|---|---|---|
| 
        project_id  | 
      
        是  | 
      
        参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。  | 
     
| 
        backup_id  | 
      
        否  | 
      
        参数解释: 实例备份信息ID,根据备份ID查询实例拓扑信息,过滤查询出来的实例,包含节点数,副本数等。参数为空时,根据restore_time查询。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。  | 
     
| 
        restore_time  | 
      
        否  | 
      
        参数解释: 恢复点,当备份ID为空时,通过此参数查询实例拓扑信息,过滤实例列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。  | 
     
| 
        source_instance_id  | 
      
        否  | 
      
        参数解释: 源实例ID,需要恢复的实例ID。 约束限制: 
 取值范围: 不涉及。 默认取值: 不涉及。  | 
     
| 
        offset  | 
      
        否  | 
      
        参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 必须为数字,不能为负数。 取值范围: 不涉及。 默认取值: 0(偏移0条数据,表示从第一条数据开始查询)  | 
     
| 
        limit  | 
      
        否  | 
      
        参数解释: 查询记录数。 约束限制: 不涉及。 取值范围: [1,100]。 默认取值: 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  | 
      
        String  | 
      
        参数解释: 实例版本信息。 取值范围: 不涉及。  | 
     
| 
        mode  | 
      
        String  | 
      
        参数解释: 部署形态。 取值范围: 
  | 
     
| 
        instance_mode  | 
      
        String  | 
      
        参数解释: 实例模型。 取值范围: 
  | 
     
请求示例
查询可用于备份恢复的实例列表。
GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0611f1bd8b00d5d32f17c017f15b599f/restorable-instances?source_instance_id=88efb3753dc844829c380edff7798eecin14&backup_id=d3f223e9c35d450ea0692bdbff686e45br14
响应示例
查询可用于备份恢复的实例列表成功。
{
    "instances": [
        {
            "instance_name": "gaussdb",
            "instance_id": "3ea6d6463c9a4baf9a47c5b74464307cin14",
            "volume_type": "ULTRAHIGH",
            "data_volume_size": 500,
            "version": "V2.0-8.102",
            "mode": "Ha",
            "instance_mode": "enterprise"
        }
    ],
    "total_count": 1
}
 状态码
- 正常
 - 异常
    
请参见状态码。
 
错误码
请参见错误码。