ListBackupData - Hologres - Alibaba Cloud Documentation Center

Retrieves a list of snapshots. Each snapshot represents a point-in-time backup that can be used to restore a new instance with its full data.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hologram:ListBackupData

list

*Instance

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

None

Request syntax

GET /api/v1/backups HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

instanceId

string

The instance ID.

hgprecn-cn-wwoxxxxx

backupType

string

The backup type, used to filter snapshots. If you leave this parameter empty, all snapshots are returned.

Valid values:

redundant_remote :
Stores instance snapshots across zones in a different region.
remote :
It is a filter for remote snapshots, not a backup type.
redundant :
Stores instance snapshots across zones within the same region.
full_remote :
Stores an instance snapshot remotely.
local :
It is a filter for local snapshots, not a backup type.
full :
Stores an instance snapshot locally.

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. redundant: Stores instance snapshots across zones within the same region. redundant_remote: Stores instance snapshots across zones in a different region. full: Stores an instance snapshot locally. full_remote: Stores an instance snapshot remotely. local: It is a filter for local snapshots, not a backup type. remote: It is a filter for remote snapshots, not a backup type.	redundant
DataGran	string	The backup granularity. Valid values: instance : Instance level.	instance
Id	integer	The unique snapshot ID.	1780805690994479105
InstanceId	string	The instance ID.	hgpostcn-cn-pe33jdxxxxx
StartTime	string	The timestamp when the backup began. Format: `YYYY-MM-DDTHH:mm:ss.SSSTZ` (UTC+8). This format is used for all time-related parameters.	2024-10-28T11:19:56.000+00:00
Status	string	The backup status. Valid values: processing : The backup is in progress. completed : The backup is complete. failed : The backup failed.	completed
TriggerType	string	The backup trigger type. Valid values: scheduled : Periodic backup. manual : Manual backup.	scheduled
DataDesc	string	The description of the snapshot. It can be updated.	demo
DataTime	string	The time when the data snapshot was created. For the format, see StartTime.	2024-10-28T12:23:37.000+00:00
DataSize	integer	The size of the snapshot, in bytes.	76085723136
EndTime	string	The time when the backup was completed. For the format, see StartTime.	2024-10-28T12:27:34.000+00:00
ColdDataSize	integer	The size of the cold data, in bytes.	32413521
InstanceType	string	The instance type. Valid values: Warehouse : Virtual warehouse instance. Standard : General-purpose instance.	Warehouse
InstanceRegion	string	The region where the instance resides.	cn-hangzhou
SnapshotRegion	string	The region where the snapshot is stored.	cn-hangzhou
InstanceZoneId	string	The zone where the instance resides.	cn-hangzhou-j
SnapshotZoneId	string	The zone where backup snapshot(s). If you use zone-redundant storage, the data is stored across multiple zones. This parameter returns one of those 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.