功能介绍

根据时间点或者备份文件查询原实例信息。

调用接口前，您需要了解API 认证鉴权。
调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

接口约束

instance_id、restore_time、backup_id三个请求参数不能都为空。

调试

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

URI

URI格式

GET https://{Endpoint}/v3/{project_id}/instance-snapshot?instance_id={instance_id}&backup_id={backup_id}&restore_time={restore_time}

URI样例

https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instance-snapshot

参数说明

表1 参数说明

参数	是否必选	参数类型	描述
project_id	是	String	租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。
instance_id	否	String	原实例ID。根据时间点恢复实例时，需要同时填写instance_id和restore_time。
restore_time	否	String	根据时间点恢复实例时，需要同时填写instance_id和restore_time。 UNIX时间戳格式，单位是毫秒，时区是UTC，某时间点实例的信息。
backup_id	否	String	备份ID。 根据备份ID恢复实例时，需要填写该参数。

请求消息

无。

响应消息

正常响应要素说明

表2 参数说明

参数	参数类型	描述
cluster_mode	String	实例部署形态。集中式Ha(主备)、分布式Independent(独立部署)。 枚举值： Ha
instance_mode	String	实例模型，企业版enterprise，标准版standard，基础版basic。 枚举值： basic standard enterprise
data_volume_size	String	磁盘大小，单位：GB。
solution	String	解决方案模板类型。集中式Ha一般用triset，分布式Independent一般为空或者默认hws。 描述如下： triset：高可用（1主2备） hws：默认。 枚举值： triset hws
node_num	Integer	节点数量。
coordinator_num	Integer	协调节点数量。
sharding_num	Integer	分片数量。
replica_num	Integer	副本数量。
engine_version	String	引擎版本。

正常响应样例

参数模板列表：

{ 
  "cluster_mode" : "Ha", 
  "instance_mode" : "enterprise", 
  "data_volume_size" : "200", 
  "solution" : "triset", 
  "node_num" : 3, 
  "coordinator_num" : 0, 
  "sharding_num" : 3, 
  "replica_num" : 3, 
  "engine_version" : "2.2.90"
}

状态码

正常

200

异常

请参见状态码。

错误码

请参见错误码。

父主题： 备份管理

同意关联代理商云淘科技，购买华为云产品更优惠（QQ 78315851）

内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家