ListBackupData
Queries a list of backups. A backup is a full data snapshot of an instance up to the snapshot time. You can fully restore the original data by purchasing a new instance.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
hologram:ListBackupData |
list |
*Instance
|
None | None |
Request syntax
GET /api/v1/backups HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
No |
The instance ID. |
hgprecn-cn-wwoxxxxx |
| backupType |
string |
No |
The backup type. Filters specific backup data by type. If this parameter is left empty, all backup data is returned. Valid values:
|
redundant |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46 |
| BackupDataList |
array<object> |
The list of backups. |
|
|
object |
|||
| BackupType |
string |
The backup type. Backup types are generally divided into two categories: 1) Local backup, where the snapshot and the instance belong to the same region. 2) Remote backup, where the snapshot and the instance belong to different regions. Valid values:
|
redundant |
| DataGran |
string |
The backup granularity. Valid values:
|
instance |
| Id |
integer |
The unique ID of the backup. |
1780805690994479105 |
| InstanceId |
string |
The instance ID. |
hgpostcn-cn-pe33jdxxxxx |
| StartTime |
string |
The start time of the backup. The time is in the UTC+8 time zone and follows the YYYY-MM-DDTHH:mm:ss.SSSTZ format. The same applies to other time fields. |
2024-10-28T11:19:56.000+00:00 |
| Status |
string |
The backup status. Valid values:
|
completed |
| TriggerType |
string |
The trigger type. Valid values:
|
scheduled |
| DataDesc |
string |
The description of the backup data. This field can be updated. |
demo |
| DataTime |
string |
The data snapshot time. For the format, refer to StartTime. |
2024-10-28T12:23:37.000+00:00 |
| DataSize |
integer |
The size of the backup data. Unit: bytes. |
76085723136 |
| EndTime |
string |
The end time of the backup. For the format, refer to StartTime. |
2024-10-28T12:27:34.000+00:00 |
| ColdDataSize |
integer |
The size of the cold storage data. Unit: bytes. |
32413521 |
| InstanceType |
string |
The instance type. Valid values:
|
Warehouse |
| InstanceRegion |
string |
The region where the instance resides. |
cn-hangzhou |
| SnapshotRegion |
string |
The region where the backup data resides. |
cn-hangzhou |
| InstanceZoneId |
string |
The zone where the instance resides. |
cn-hangzhou-j |
| SnapshotZoneId |
string |
The zone where the backup data resides. For zone-redundant storage, the data is stored across multiple zones, and this field indicates one of the zones. |
cn-hangzhou-j |
| InstanceName |
string |
The instance name. |
my-hologres-dw |
Examples
Success response
JSON format
{
"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"
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.