查询备份数据列表。一份备份是对实例截止快照时间的全量数据快照,可以通过新购实例完全恢复原来的数据。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
hologram:ListBackupData |
list |
*Instance
|
无 | 无 |
请求语法
GET /api/v1/backups HTTP/1.1
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
instanceId |
string |
否 |
实例 id。 |
hgprecn-cn-wwoxxxxx |
backupType |
string |
否 |
备份类型。根据类型过滤特定的备份数据,为空则返回所有备份数据。 枚举值:
|
redundant |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
RequestId |
string |
请求 Id |
4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46 |
BackupDataList |
array<object> |
备份列表。 |
|
object |
|||
BackupType |
string |
备份类型。备份类型总体上分两种:1)本地备份,快照与实例属于相同 Region;2)远程备份,快照与实例属于不同 Region。
|
redundant |
DataGran |
string |
备份粒度。 枚举值:
|
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 |
备份状态。 枚举值:
|
completed |
TriggerType |
string |
触发类型。 枚举值:
|
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 |
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"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。