根据时间点或者备份文件查询原实例信息
接口约束
restore_time和backup_id参数不能同时为空。
- backup_id非空时,按照backup_id进行查询。
- backup_id为空时,按照restore_time进行查询。
- restore_time和backup_id均非空时,按照backup_id进行查询。
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/instance-snapshot
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id | 否 | String | 原实例ID。 当restore_time非空时,instance_id是必选参数。 |
restore_time | 否 | String | 根据时间点查看实例的备份信息时,需要填写restore_time。 UNIX时间戳格式,单位是毫秒,时区是UTC,某时间点实例的信息。 |
backup_id | 否 | String | 备份ID。 根据备份ID恢复实例时,需要填写该参数。 |
请求参数
无。
响应参数
参数 | 参数类型 | 描述 |
|---|---|---|
cluster_mode | String | 实例部署形态。 枚举值:
|
instance_mode | String | 实例模型。 枚举值:
|
data_volume_size | String | 磁盘大小,单位:GB。 |
solution | String | 解决方案模板类型。 枚举值:
|
node_num | Integer | 节点数量。 |
coordinator_num | Integer | 协调节点数量。 |
sharding_num | Integer | 分片数量。 |
replica_num | Integer | 副本数量。 |
engine_version | String | 引擎版本。 |
请求示例
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instance-snapshot
响应示例
{
"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"
} 状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。

