All Products
Search

This Product

    Hologres:ListBackupData

    Document Center

    Hologres:ListBackupData

    Last Updated:Jun 10, 2026

    Mengambil daftar snapshot. Setiap snapshot mewakili cadangan pengatur waktu yang dapat Anda gunakan untuk memulihkan instans baru dengan data lengkapnya.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    hologram:ListBackupData

    list

    *Instance

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

    		 None None

    Sintaks permintaan

    GET /api/v1/backups HTTP/1.1

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    instanceId

    string

    No

    ID instans.

    hgprecn-cn-wwoxxxxx
    backupType

    string

    No

    Tipe cadangan yang digunakan untuk memfilter snapshot. Jika Anda mengosongkan parameter ini, semua snapshot akan dikembalikan.

    Valid values:

    • redundant_remote :

      Menyimpan snapshot instans di seluruh zona di wilayah yang berbeda.

    • remote :

      Filter untuk snapshot jarak jauh, bukan tipe cadangan.

    • redundant :

      Menyimpan snapshot instans di seluruh zona dalam wilayah yang sama.

    • full_remote :

      Menyimpan snapshot instans secara jarak jauh.

    • local :

      Filter untuk snapshot lokal, bukan tipe cadangan.

    • full :

      Menyimpan snapshot instans secara lokal.

    redundant

    Elemen respons

    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

    Contoh

    Respons sukses

    JSONformat

    {
  "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"
    }
  ]
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.