ListBackupData - 查询备份列表_实时数仓 Hologres(Hologres)-阿里云帮助中心

查询备份数据列表。一份备份是对实例截止快照时间的全量数据快照，可以通过新购实例完全恢复原来的数据。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hologram:ListBackupData

list

*Instance

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

无

请求语法

GET /api/v1/backups HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	否	实例 id。	hgprecn-cn-wwoxxxxx
backupType	string	否	备份类型。根据类型过滤特定的备份数据，为空则返回所有备份数据。枚举值： redundant_remote : 同城冗余备份 remote : 远程备份 redundant : 同城冗余备份 full_remote : 单备份 local : 本地备份 full : 单备份	redundant

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 Id	4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46
BackupDataList	array<object>	备份列表。
	object
BackupType	string	备份类型。备份类型总体上分两种：1）本地备份，快照与实例属于相同 Region；2）远程备份，快照与实例属于不同 Region。 redundant: 本地备份，同城跨可用区多副本存储。 redundant_remote: 远程备份，同城跨可用区多副本存储，redundant 类型在异地的拷贝。 full: 本地备份，单副本存储。 full_remote: 远程备份，单副本存储，full 类型在异地的拷贝。 local: 不代表具体备份类型，只用于过滤本地备份数据。 remote: 不代表具体备份类型，只用于过滤远程备份数据。	redundant
DataGran	string	备份粒度。枚举值： instance : 实例级	instance
Id	integer	备份唯一 Id。	1780805690994479105
InstanceId	string	实例 id。	hgpostcn-cn-pe33jdxxxxx
StartTime	string	备份开始时间。北京时间，格式 YYYY-MM-DDTHH:mm:ss.SSSTZ。下同	2024-10-28T11:19:56.000+00:00
Status	string	备份状态。枚举值： processing : 处理中 completed : 已完成 failed : 失败	completed
TriggerType	string	触发类型。枚举值： scheduled : 周期备份 manual : 手动备份	scheduled
DataDesc	string	备份数据描述。可更新。	demo
DataTime	string	数据快照时间。格式参考 StartTime。	2024-10-28T12:23:37.000+00:00
DataSize	integer	备份数据大小。单位：字节。	76085723136
EndTime	string	备份结束时间。格式参考 StartTime。	2024-10-28T12:27:34.000+00:00
ColdDataSize	integer	冷存数据大小。单位：字节	32413521
InstanceType	string	实例类型。枚举值： Warehouse : 计算组型 Standard : 标准型	Warehouse
InstanceRegion	string	实例所在地域。	cn-hangzhou
SnapshotRegion	string	备份数据所在地域。	cn-hangzhou
InstanceZoneId	string	实例所在可用区。	cn-hangzhou-j
SnapshotZoneId	string	备份数据所在可用区。其中，同城冗余存储保存在多可用区，这里是其中一个。	cn-hangzhou-j
InstanceName	string	实例名称。	my-hologres-dw

示例

正常返回示例

JSON格式

{
  "RequestId": "4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46",
  "BackupDataList": [
    {
      "BackupType": "redundant",
      "DataGran": "instance",
      "Id": 1780805690994479000,
      "InstanceId": "hgpostcn-cn-pe33jdxxxxx",
      "StartTime": "2024-10-28T11:19:56.000+00:00",
      "Status": "completed",
      "TriggerType": "scheduled",
      "DataDesc": "demo",
      "DataTime": "2024-10-28T12:23:37.000+00:00",
      "DataSize": 76085723136,
      "EndTime": "2024-10-28T12:27:34.000+00:00",
      "ColdDataSize": 32413521,
      "InstanceType": "Warehouse",
      "InstanceRegion": "cn-hangzhou",
      "SnapshotRegion": "cn-hangzhou",
      "InstanceZoneId": "cn-hangzhou-j",
      "SnapshotZoneId": "cn-hangzhou-j",
      "InstanceName": "my-hologres-dw"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。