All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeClusterBackupList

    Document Center

    Tair (Redis® OSS-Compatible):DescribeClusterBackupList

    Last Updated:Mar 30, 2026

    Menampilkan daftar backup dari instans kluster Tair (kompatibel dengan Redis OSS).

    Deskripsi operasi

    API 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 mengambil daftar wilayah terbaru.

    cn-zhangjiakou
    InstanceId

    string

    Yes

    ID instans.

    r-t4nj72oug5r5646qog
    ClusterBackupId

    string

    No

    ID set cadangan.

    cb-hyxdof5x9kqbtust

    PageSize

    integer

    No

    Jumlah entri per halaman.

    Nilai yang valid:

    • 30

    • 50

    • 100

    • 200

    • 300

    • 5

    • 10

    • 15

    • 20

    30
    PageNumber

    integer

    No

    Nomor halaman.

    1
    StartTime

    string

    Yes

    Awal rentang waktu untuk kueri. Tentukan waktu dalam standar ISO 8601 dengan format yyyy-MM-ddTHH:mmZ. Waktu harus dalam UTC.

    2024-06-28T08:26Z
    EndTime

    string

    Yes

    Akhir rentang waktu untuk kueri. Tentukan waktu dalam standar ISO 8601 dengan format yyyy-MM-ddTHH:mmZ. Waktu harus dalam UTC. Waktu akhir harus lebih baru daripada waktu mulai.

    2024-07-01T09:26Z
    NoShardBackup

    string

    No

    Menentukan apakah akan menampilkan informasi set cadangan untuk shard dalam instans.

    • true: tidak menampilkan informasi set cadangan untuk shard dalam instans.

    • false (default): menampilkan informasi set cadangan untuk shard dalam instans.

    Nilai yang valid:

    • True

    • False

    True

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    RequestId

    string

    ID permintaan.

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

    integer

    Jumlah maksimum entri yang dikembalikan.

    4
    PageNumber

    integer

    Nomor halaman.

    1
    PageSize

    integer

    Jumlah maksimum entri yang dikembalikan per halaman.

    30
    FullStorageSize

    integer

    Ukuran file cadangan penuh instans. Satuan: byte. Cadangan penuh berasal dari cadangan terjadwal, cadangan manual, dan cadangan yang dihasilkan selama analisis cache.

    Catatan

    Nilai parameter ini tidak bergantung pada jumlah dan ukuran set cadangan yang dikembalikan. Sebaliknya, nilai ini merepresentasikan ukuran semua cadangan penuh instans yang valid.

    1000
    LogStorageSize

    integer

    Ukuran file cadangan log instans. Satuan: byte. Parameter ini hanya berlaku jika flashback diaktifkan.

    Catatan

    Nilai parameter ini tidak bergantung pada jumlah dan ukuran set cadangan yang dikembalikan. Sebaliknya, nilai ini merepresentasikan ukuran semua cadangan log instans yang valid.

    5000
    FreeSize

    integer

    Parameter ini tidak berlaku. Abaikan parameter ini.

    100000
    ClusterBackups

    array<object>

    Set cadangan instans. Satu cadangan berisi set cadangan semua shard dalam instans.

    array<object>

    Set cadangan instans. Satu cadangan berisi set cadangan semua shard dalam instans.

    IsAvail

    integer

    Menunjukkan apakah set cadangan valid. Nilai 0 menandakan bahwa cadangan tingkat shard gagal atau belum selesai.

    1
    ClusterBackupId

    string

    ID set cadangan.

    cb-zmdqj2m3xyxjtdt0
    ClusterBackupStatus

    string

    Status set cadangan.

    • OK

    • RUNNING

    • Failed

    OK
    ClusterBackupSize

    string

    Ukuran set cadangan.

    2048
    ClusterBackupStartTime

    string

    Waktu mulai pencadangan.

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

    string

    Waktu selesai pencadangan.

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

    string

    Mode pencadangan.

    Automated
    ShardClassMemory

    integer

    Ukuran memori satu shard selama pencadangan penuh. Satuan: MB.

    1024
    Backups

    array<object>

    Set cadangan semua shard dalam instans.

    array<object>

    Set cadangan yang dikueri.

    BackupId

    string

    ID file cadangan.

    514645788
    InstanceName

    string

    Nama instans.

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

    string

    URL unduh publik file cadangan.

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

    string

    URL unduh internal file cadangan.

    Catatan

    Anda dapat menggunakan URL ini untuk mengunduh file cadangan dari instans Elastic Compute Service (ECS) yang terhubung ke instans Tair (kompatibel dengan Redis OSS). Instans ECS tersebut harus berada dalam virtual private cloud (VPC) yang sama dengan instans Tair (kompatibel dengan Redis OSS).

    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 pencadangan. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

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

    string

    Waktu selesai pencadangan. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

    2024-01-09T17:21:57
    BackupSize

    string

    Ukuran file cadangan. Satuan: byte.

    1024
    IsAvail

    string

    Menunjukkan apakah set cadangan tersedia. Nilai yang valid:

    • 0: tidak tersedia

    • 1: tersedia

    1
    BackupStatus

    string

    Status pencadangan. Nilai yang valid:

    • OK

    • ERROR

    OK
    BackupName

    string

    Nama cadangan.

    hins100322105_data_20240110012135.rdb
    Engine

    string

    Engine database. Nilai kembali adalah redis.

    redis
    ExtraInfo

    object

    Informasi tambahan.

    CustinsDbVersion

    string

    Versi engine.

    5.0
    Progress

    string

    Kemajuan pencadangan. Sistem hanya menampilkan kemajuan tugas pencadangan yang sedang berjalan.

    100%
    ExpectExpireTime

    string

    Waktu hidup (TTL) set cadangan, dalam format yyyy-MM-ddTHH:mmZ (waktu 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.