All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeClusterBackupList

    Document Center

    Tair (Redis® OSS-Compatible):DescribeClusterBackupList

    Last Updated:Oct 12, 2026

    Mengkueri daftar cadangan instans kluster database ApsaraDB for Tair (Redis® OSS-Compatible).

    Deskripsi operasi

    Operasi ini hanya berlaku untuk instans cloud-native.

    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

    kvstore:DescribeClusterBackupList

    get

    *DBInstance

    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID wilayah instans. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.

    cn-zhangjiakou
    InstanceId

    string

    Yes

    ID instans.

    r-t4nj72oug5r5646qog
    ClusterBackupId

    string

    No

    ID set cadangan kluster.

    cb-hyxdof5x9kqbtust

    PageSize

    integer

    No

    Jumlah entri yang dikembalikan pada setiap halaman.

    Valid values:

    • 5 :

      5 entri per halaman.

    • 10 :

      10 entri per halaman.

    • 15 :

      15 entri per halaman.

    • 20 :

      20 entri per halaman.

    • 30 :

      30 entri per halaman.

    • 50 :

      50 entri per halaman.

    • 100 :

      100 entri per halaman.

    • 200 :

      200 entri per halaman.

    • 300 :

      300 entri per halaman.

    30
    PageNumber

    integer

    No

    Nomor halaman.

    1
    StartTime

    string

    Yes

    Waktu mulai kueri. Tentukan waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu harus dalam UTC.

    2024-06-28T08:26Z
    EndTime

    string

    Yes

    Waktu akhir kueri. Waktu akhir harus lebih lambat dari waktu mulai. Tentukan waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu harus dalam UTC.

    2024-07-01T09:26Z
    NoShardBackup

    string

    No

    Apakah akan menampilkan detail set cadangan untuk node kluster. Nilai valid:

    • false (default): Menampilkan informasi set cadangan node kluster.

    • true: Tidak menampilkan informasi set cadangan node kluster.

    Valid values:

    • True :

      Tidak menampilkan detail set cadangan shard.

    • False :

      Menampilkan detail set cadangan shard.

    True

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Tanggapan.

    RequestId

    string

    ID permintaan.

    C009DA42-3B19-5B81-963D-1509DE2408DD
    MaxResults

    integer

    Jumlah maksimum entri yang dikembalikan untuk permintaan saat ini.

    4
    PageNumber

    integer

    Nomor halaman, yang sama dengan parameter permintaan.

    1
    PageSize

    integer

    Jumlah maksimum entri per halaman, yang sama dengan parameter permintaan.

    30
    FullStorageSize

    integer

    Ukuran file cadangan penuh untuk instans saat ini. Unit: byte. Cadangan penuh mencakup cadangan terjadwal harian, cadangan manual, dan cadangan yang dihasilkan selama analisis cache.

    Catatan

    Nilai ini tidak bergantung pada jumlah dan ukuran set cadangan yang dikembalikan dalam permintaan saat ini. Nilai ini mewakili total ukuran semua cadangan penuh yang valid untuk instans.

    1000
    LogStorageSize

    integer

    Ukuran file cadangan log instans saat ini. Unit: byte. Nilai ini hanya valid ketika fitur flashback diaktifkan.

    Catatan

    Nilai ini tidak bergantung pada jumlah dan ukuran set cadangan dalam tanggapan permintaan saat ini. Nilai ini mewakili total ukuran semua cadangan log instans yang valid untuk instans.

    5000
    FreeSize

    integer

    Parameter ini tidak berlaku. Abaikan parameter ini.

    100000
    ClusterBackups

    array<object>

    Daftar set cadangan kluster. Setiap cadangan kluster mengandung set cadangan semua node.

    array<object>

    Daftar set cadangan kluster. Setiap cadangan kluster mengandung set cadangan semua node.

    IsAvail

    integer

    Apakah set cadangan kluster valid. Nilainya adalah 0 jika set cadangan node anak tidak lengkap atau gagal.

    1
    ClusterBackupId

    string

    ID set cadangan kluster.

    cb-zmdqj2m3xyxjtdt0
    ClusterBackupStatus

    string

    Status set cadangan kluster. Nilai valid:

    • OK: Berhasil.

    • RUNNING: Berjalan.

    • Nilai lainnya: Gagal.

    OK
    ClusterBackupSize

    string

    Ukuran set cadangan kluster.

    2048
    ClusterBackupStartTime

    string

    Waktu mulai cadangan kluster. Waktu dalam format YYYY-MM-DDTHH:mm:ssZ dan ditampilkan dalam UTC.

    2024-01-10T17:21:25Z
    ClusterBackupEndTime

    string

    Waktu akhir cadangan kluster. Waktu dalam format YYYY-MM-DDTHH:mm:ssZ dan ditampilkan dalam UTC.

    2024-01-10T17:21:55Z
    ClusterBackupMode

    string

    Mode cadangan kluster.

    Automated
    ShardClassMemory

    integer

    Ukuran spesifikasi memori satu node database saat cadangan penuh dibuat. Unit: MB.

    1024
    Backups

    array<object>

    Kumpulan set cadangan untuk semua node anak di bawah satu set cadangan kluster.

    array<object>

    Detail set cadangan.

    BackupId

    string

    ID file cadangan.

    514645788
    InstanceName

    string

    Nama instans.

    r-bp1y4is8svonly****-db-0
    BackupDownloadURL

    string

    URL unduhan publik file cadangan.

    http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
    BackupIntranetDownloadURL

    string

    URL unduhan internal file cadangan.

    Catatan

    Anda dapat menggunakan URL ini untuk mengunduh file cadangan pada instans ECS yang terhubung ke instans saat ini. Kedua instans harus berada di VPC yang sama.

    http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
    RecoverConfigMode

    string

    Parameter ini tidak berlaku. Abaikan parameter ini.

    null
    BackupStartTime

    string

    Waktu mulai cadangan. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC.

    2024-01-09T17:21:30Z
    BackupEndTime

    string

    Waktu akhir cadangan. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC.

    2024-01-09T17:21:57
    BackupSize

    string

    Ukuran file cadangan. Unit: byte.

    1024
    IsAvail

    string

    Apakah set cadangan tersedia. Nilai valid:

    • 0: Tidak tersedia.

    • 1: Tersedia.

    1
    BackupStatus

    string

    Status cadangan. Nilai valid:

    • OK: Berhasil.

    • ERROR: Gagal.

    OK
    BackupName

    string

    Nama cadangan.

    hins100322105_data_20240110012135.rdb
    Engine

    string

    Tipe engine database. Nilainya tetap sebagai redis.

    redis
    ExtraInfo

    object

    Informasi tambahan.

    CustinsDbVersion

    string

    Versi engine database.

    5.0
    Progress

    string

    Progres cadangan. Parameter ini hanya ditampilkan untuk cadangan yang sedang berlangsung.

    100%
    ExpectExpireTime

    string

    Waktu kedaluwarsa set cadangan. Waktu dalam format yyyy-MM-ddTHH:mmZ dan ditampilkan dalam UTC.

    2025-06-01T21:51:22Z

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "C009DA42-3B19-5B81-963D-1509DE2408DD",
  "MaxResults": 4,
  "PageNumber": 1,
  "PageSize": 30,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "ClusterBackups": [
    {
      "IsAvail": 1,
      "ClusterBackupId": "cb-zmdqj2m3xyxjtdt0",
      "ClusterBackupStatus": "OK",
      "ClusterBackupSize": "2048",
      "ClusterBackupStartTime": "2024-01-10T17:21:25Z",
      "ClusterBackupEndTime": "2024-01-10T17:21:55Z",
      "ClusterBackupMode": "Automated",
      "ShardClassMemory": 1024,
      "Backups": [
        {
          "BackupId": "514645788",
          "InstanceName": "r-bp1y4is8svonly****-db-0",
          "BackupDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
          "BackupIntranetDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
          "RecoverConfigMode": "null",
          "BackupStartTime": "2024-01-09T17:21:30Z",
          "BackupEndTime": "2024-01-09T17:21:57",
          "BackupSize": "1024",
          "IsAvail": "1",
          "BackupStatus": "OK",
          "BackupName": "hins100322105_data_20240110012135.rdb",
          "Engine": "redis",
          "ExtraInfo": {
            "CustinsDbVersion": "5.0"
          }
        }
      ],
      "Progress": "100%",
      "ExpectExpireTime": "2025-06-01T21:51:22Z"
    }
  ]
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.