ListBackupData

Updated at:

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

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 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_remote :

    Zone-redundant backup.

  • remote :

    Remote backup.

  • redundant :

    Zone-redundant backup.

  • full_remote :

    Single-copy backup.

  • local :

    Local backup.

  • full :

    Single-copy backup.

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: Local backup with cross-zone multi-copy storage in the same region.

  • redundant_remote: Remote backup with cross-zone multi-copy storage in the same region, which is a cross-region copy of the redundant type.

  • full: Local backup with single-copy storage.

  • full_remote: Remote backup with single-copy storage, which is a cross-region copy of the full type.

  • local: Does not represent a specific backup type and is only used to filter local backup data.

  • remote: Does not represent a specific backup type and is only used to filter remote backup data.

redundant

DataGran

string

The backup granularity.

Valid values:

  • instance :

    Instance level.

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:

  • processing :

    Processing.

  • completed :

    Completed.

  • failed :

    Failed.

completed

TriggerType

string

The trigger type.

Valid values:

  • scheduled :

    Scheduled backup.

  • manual :

    Manual backup.

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 :

    Compute group.

  • Standard :

    Standard.

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.