All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeBackups

    Document Center

    Tair (Redis® OSS-Compatible):DescribeBackups

    Last Updated:Jun 12, 2026

    Mengkueri informasi file cadangan dari instans database Database Apsara for Tair (Redis® OSS-Compatible).

    Deskripsi operasi

    Operasi ini tidak berlaku untuk instans kluster cloud-native. Untuk instans kluster cloud-native, panggil operasi DescribeClusterBackupList.

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

    get

    *DBInstance

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    ID instans.

    r-bp1zxszhcgatnx****
    BackupId

    integer

    No

    ID file cadangan.

    11611111
    BackupJobId

    integer

    No

    ID tugas cadangan, yang dikembalikan oleh CreateBackup. Jika CreateBackup mengembalikan beberapa nilai BackupJobId, panggil operasi ini untuk mengkueri masing-masing secara terpisah.

    10001
    PageSize

    integer

    No

    Jumlah entri maksimum per halaman. Nilai valid: 30, 50, 100, 200, dan 300.

    30
    PageNumber

    integer

    No

    Nomor halaman. Nilai harus lebih besar dari 0 dan tidak boleh melebihi nilai maksimum tipe data Integer. Nilai default: 1.

    1
    StartTime

    string

    Yes

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

    2019-03-11T10:00Z
    EndTime

    string

    Yes

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

    2019-03-14T18:00Z
    NeedAof

    string

    No

    Apakah akan mengaktifkan persistensi append-only file (AOF). Nilai valid:

    • 0: Dinonaktifkan.

    • 1: Diaktifkan.

    Catatan

    Nilai default: 0.

    1

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    ID permintaan.

    963C20F0-7CE1-4591-AAF3-6F3CD1CE****
    PageNumber

    integer

    Nomor halaman.

    1
    PageSize

    integer

    Jumlah entri maksimum per halaman.

    30
    TotalCount

    integer

    Jumlah total set cadangan.

    5
    FullStorageSize

    integer

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

    Catatan

    Nilai ini tidak terkait dengan jumlah atau ukuran set cadangan yang dikembalikan dalam permintaan saat ini. Sebaliknya, nilai ini mewakili ukuran total semua cadangan penuh yang valid untuk instans.

    1000
    LogStorageSize

    integer

    Ukuran total file cadangan log instans untuk instans saat ini, dalam byte. Nilai ini hanya valid ketika flashback diaktifkan.

    Catatan

    Nilai ini tidak terkait dengan jumlah atau ukuran set cadangan yang dikembalikan dalam tanggapan saat ini. Sebaliknya, nilai ini mewakili ukuran total semua cadangan log yang valid untuk instans.

    5000
    FreeSize

    integer

    Parameter ini tidak berlaku. Abaikan parameter ini..

    100000
    Backups

    object

    Backup

    array<object>

    Detail set cadangan.

    object

    Detail set cadangan.

    BackupStatus

    string

    The status of the backup. Valid values:

    • Success

    • Failed

    Success
    BackupStartTime

    string

    The start time of the backup.

    2019-03-14T05:28:50Z
    BackupType

    string

    The backup type. Valid values:

    • FullBackup

    • IncrementalBackup

    FullBackup
    BackupDownloadURL

    string

    The public download URL of the backup file.

    https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
    NodeInstanceId

    string

    The node ID.

    Catatan

    If the instance uses the standard architecture, this parameter returns the instance ID.

    r-bp10noxlhcoim2****-db-1
    BackupEndTime

    string

    The end time of the backup.

    2019-03-14T05:31:13Z
    BackupId

    integer

    The ID of the backup file.

    165*****50
    BackupDBNames

    string

    The names of the databases that are backed up. The default value is all, which indicates that all databases are backed up.

    all
    EngineVersion

    string

    The engine version (major version) of the instance.

    4.0
    BackupIntranetDownloadURL

    string

    The internal download URL of the backup file.

    Catatan

    You can use this URL to download the backup file from an Elastic Compute Service (ECS) instance that is connected to the Tair instance. The ECS instance must belong to the same classic network or reside in the same virtual private cloud (VPC) as the Tair instance.

    https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
    BackupSize

    integer

    The size of the backup file.

    1024
    BackupMode

    string

    The backup mode. Valid values:

    • Automated

    • Manual

    Automated
    BackupMethod

    string

    The backup method. Valid values:

    • Logical

    • Physical

    Physical
    BackupJobID

    integer

    The ID of the backup task.

    24340
    RecoverConfigMode

    string

    If the backup includes account information, kernel parameters and whitelist details.

    {"whitelist":true,"config":true,"account":true}
    ExpectExpireTime

    string

    2025-06-01T21:51:22Z
    AccessDeniedDetail

    object

    Parameter ini tidak digunakan lagi. Abaikan parameter ini.

    AuthAction

    string

    Lihat deskripsi di atas.

    -
    AuthPrincipalDisplayName

    string

    Lihat deskripsi di atas.

    -
    AuthPrincipalOwnerId

    string

    Lihat deskripsi di atas.

    -
    AuthPrincipalType

    string

    Lihat deskripsi di atas.

    -
    EncodedDiagnosticMessage

    string

    Lihat deskripsi di atas.

    -
    NoPermissionType

    string

    Lihat deskripsi di atas.

    -
    PolicyType

    string

    Lihat deskripsi di atas.

    -

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 5,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupStartTime": "2019-03-14T05:28:50Z",
        "BackupType": "FullBackup",
        "BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "NodeInstanceId": "r-bp10noxlhcoim2****-db-1",
        "BackupEndTime": "2019-03-14T05:31:13Z",
        "BackupId": 0,
        "BackupDBNames": "all",
        "EngineVersion": "4.0",
        "BackupIntranetDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "BackupSize": 1024,
        "BackupMode": "Automated",
        "BackupMethod": "Physical",
        "BackupJobID": 24340,
        "RecoverConfigMode": "{\"whitelist\":true,\"config\":true,\"account\":true}",
        "ExpectExpireTime": "2025-06-01T21:51:22Z"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  }
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidStartTime.Malformed The Specified parameter StartTime is not valid.
    400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid.
    400 InvalidEngineVersion.Malformed The Specified EngieVersion is not valid.
    400 InvalidStartTimeAndEndTime.Malformed The end time must be greater than the start time.
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.