All Products
Search

This Product

    :Kueri pengaturan cadangan

    Document Center

    :Kueri pengaturan cadangan

    Last Updated:May 26, 2026

    Anda dapat memanggil operasi DescribeBackupPolicy untuk mengkueri pengaturan cadangan suatu instans.

    Debugging

    OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi ini untuk berbagai SDK.

    Parameter permintaan

    Parameter Type Required Example Description
    Action String Yes DescribeBackupPolicy

    Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeBackupPolicy.

    DBInstanceId String Yes rm-uf6wjk5xxxxxxx

    ID instans.

    BackupPolicyMode String No DataBackupPolicy

    Jenis cadangan. Nilai yang valid:

    • DataBackupPolicy: cadangan data
    • LogBackupPolicy: cadangan log
    CompressType String No 1

    Metode yang digunakan untuk mengompres data cadangan. Nilai yang valid:

    • 0: Data cadangan tidak dikompres.
    • 1: Data cadangan dikompres menggunakan zlib.
    • 2: Data cadangan dikompres menggunakan zlib yang memanggil lebih dari satu thread secara paralel untuk setiap cadangan.
    • 4: Data cadangan dikompres menggunakan QuickLZ dan dapat digunakan untuk memulihkan database dan tabel tertentu.
    • 8: Data cadangan dikompres menggunakan QuickLZ tetapi tidak dapat digunakan untuk memulihkan database atau tabel tertentu. Nilai ini hanya tersedia jika instans menjalankan MySQL 8.0.
    ReleasedKeepPolicy String No Lastest

    Kebijakan yang digunakan untuk menyimpan file cadangan arsip jika instans dilepas (released). Nilai yang valid:

    • None: Tidak ada file cadangan arsip yang disimpan.
    • Lastest: Hanya file cadangan arsip terakhir yang disimpan.
    • All: Semua file cadangan arsip disimpan.

    Parameter respons

    Parameter Type Example Description
    LogBackupRetentionPeriod Integer 7

    Jumlah hari penyimpanan file cadangan log.

    ArchiveBackupKeepPolicy String ByMonth

    Siklus penyimpanan file cadangan arsip.

    ArchiveBackupKeepCount String 1

    Jumlah file cadangan arsip yang disimpan.

    LocalLogRetentionHours Integer 0

    Jumlah jam penyimpanan file cadangan log pada instans.

    BackupRetentionPeriod Integer 7

    Jumlah hari penyimpanan file cadangan data.

    RequestId String B87E2AB3-B7C9-4394-9160-7F639F732031

    ID permintaan.

    PreferredBackupPeriod String Monday,Wednesday,Friday,Sunday

    Siklus pelaksanaan cadangan. Pisahkan beberapa nilai dengan koma (,). Nilai yang valid:

    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday
    • Sunday
    CompressType String 1

    Metode yang digunakan untuk mengompres data cadangan. Nilai yang valid:

    • 0: Data cadangan tidak dikompres.
    • 1: Data cadangan dikompres menggunakan zlib.
    • 2: Data cadangan dikompres menggunakan zlib yang memanggil lebih dari satu thread secara paralel untuk setiap cadangan.
    • 4: Data cadangan dikompres menggunakan QuickLZ dan dapat digunakan untuk memulihkan database dan tabel tertentu.
    • 8: Data cadangan dikompres menggunakan QuickLZ tetapi tidak dapat digunakan untuk memulihkan database atau tabel tertentu. Nilai ini hanya tersedia jika instans menjalankan MySQL 8.0.
    SupportReleasedKeep Integer 0

    Parameter cadangan.

    LocalLogRetentionSpace String 30

    Penggunaan disk space maksimum yang diizinkan untuk file cadangan log pada instans.

    SupportVolumeShadowCopy Integer 1

    Menunjukkan apakah instans mendukung cadangan snapshot. Nilai yang valid:

    • 1: Instans mendukung cadangan snapshot.
    • 0: Instans tidak mendukung cadangan snapshot.
    Catatan Parameter ini hanya dikembalikan jika instans menjalankan SQL Server.
    BackupMethod String Physical

    Metode pencadangan instans. Nilai yang valid:

    • Physical: cadangan fisik
    • Snapshot: cadangan snapshot
    Catatan Parameter ini hanya dikembalikan jika instans menjalankan SQL Server dan menggunakan SSD standar atau ESSD (enhanced SSDs).
    LogBackupFrequency String LogInterval

    Frekuensi pencadangan log. Nilai yang valid:

    • LogInterval: Cadangan log dilakukan setiap 30 menit.
    • Nilai default: sama dengan nilai parameter PreferredBackupPeriod.
    Catatan Parameter LogBackupFrequency hanya dikembalikan jika instans menjalankan SQL Server.
    PreferredNextBackupTime String 2018-01-19T15:15Z

    Waktu pelaksanaan cadangan berikutnya. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mmZ. Waktu ditampilkan dalam UTC.

    HighSpaceUsageProtection String Enable

    Menunjukkan apakah fitur penghapusan cadangan log diaktifkan. Jika penggunaan disk melebihi 80% atau sisa disk space kurang dari 5 GB pada instans, fitur ini akan menghapus file log biner. Nilai yang valid:

    • Disable
    • Enable
    ArchiveBackupRetentionPeriod String 365

    Jumlah hari penyimpanan file cadangan arsip.

    BackupInterval String 30

    Interval cadangan. Satuan: menit.

    • Jika instans menjalankan MySQL, intervalnya sama dengan nilai parameter Snapshot Backup Start Time (bukan parameter Snapshot Backup Period) di Konsol ApsaraDB RDS. Untuk informasi selengkapnya, lihat Mencadangkan instans ApsaraDB RDS for MySQL.
    • Jika instans menjalankan SQL Server, intervalnya sama dengan frekuensi pencadangan log.
    ReleasedKeepPolicy String None

    Kebijakan yang digunakan untuk menyimpan file backup terarsip saat instans dirilis. Nilai yang valid:

    • None: Tidak ada file backup terarsip yang disimpan.
    • Lastest: Hanya file backup terarsip terakhir yang disimpan.
    • All: Semua file backup terarsip disimpan.
    PreferredBackupTime String 15:00Z-16:00Z

    Waktu pelaksanaan cadangan data. Waktu mengikuti standar ISO 8601 dalam format HH:mmZ-HH:mmZ. Waktu ditampilkan dalam UTC.

    LogBackupLocalRetentionNumber Integer 60

    Jumlah file log biner yang disimpan pada instans.

    Category String Standard

    Menunjukkan apakah fitur pencadangan dalam hitungan detik satuan diaktifkan. Fitur ini memungkinkan ApsaraDB RDS menyelesaikan pencadangan dalam hitungan detik satuan. Nilai yang valid:

    • Flash: Fitur pencadangan dalam hitungan detik satuan diaktifkan.
    • Standard: Fitur pencadangan dalam hitungan detik satuan dinonaktifkan.
    Catatan Parameter ini hanya berlaku jika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
    EnableBackupLog String 1

    Menunjukkan apakah fitur cadangan log diaktifkan. Nilai yang valid:

    • 1: Fitur cadangan log diaktifkan.
    • 0: Fitur cadangan log dinonaktifkan.
    BackupLog String Enable

    Menunjukkan apakah fitur cadangan log diaktifkan. Nilai yang valid:

    • Enable
    • Disabled
    EnableIncrementDataBackup Boolean True

    Menunjukkan apakah cadangan inkremental diaktifkan. Nilai yang valid:

    • True: Cadangan inkremental diaktifkan.
    • False: Cadangan inkremental dinonaktifkan.

    Contoh

    Contoh permintaan

    http(s)://rds.aliyuncs.com/?Action=DescribeBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&<Common request parameters>

    Contoh respons sukses

    XML format

    HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupPolicyResponse>
<Category>Standard</Category>
<ArchiveBackupRetentionPeriod>0</ArchiveBackupRetentionPeriod>
<RequestId>292884FE-D689-47A2-9829-C05E63366201</RequestId>
<Duplication/>
<ReleasedKeepPolicy>None</ReleasedKeepPolicy>
<ArchiveBackupKeepPolicy>ByMonth</ArchiveBackupKeepPolicy>
<PreferredBackupTime>00:00Z-01:00Z</PreferredBackupTime>
<LocalLogRetentionHours>18</LocalLogRetentionHours>
<PreferredNextBackupTime>2021-01-07T00:40Z</PreferredNextBackupTime>
<HighSpaceUsageProtection>Enable</HighSpaceUsageProtection>
<CompressType>1</CompressType>
<LogBackupFrequency>LogInterval</LogBackupFrequency>
<PreferredBackupPeriod>Tuesday,Thursday,Saturday</PreferredBackupPeriod>
<ArchiveBackupKeepCount>1</ArchiveBackupKeepCount>
<LogBackupRetentionPeriod>7</LogBackupRetentionPeriod>
<LogBackupLocalRetentionNumber>60</LogBackupLocalRetentionNumber>
<BackupLog>Enable</BackupLog>
<EnableBackupLog>1</EnableBackupLog>
<SupportReleasedKeep>0</SupportReleasedKeep>
<SupportVolumeShadowCopy>1</SupportVolumeShadowCopy>
<LocalLogRetentionSpace>30</LocalLogRetentionSpace>
<BackupRetentionPeriod>10</BackupRetentionPeriod>
<DuplicationContent/>
<BackupInterval>30</BackupInterval>
</DescribeBackupPolicyResponse>

    JSON format

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "Category" : "Standard",
  "ArchiveBackupRetentionPeriod" : 0,
  "RequestId" : "292884FE-D689-47A2-9829-C05E63366201",
  "Duplication" : "",
  "ReleasedKeepPolicy" : "None",
  "ArchiveBackupKeepPolicy" : "ByMonth",
  "PreferredBackupTime" : "00:00Z-01:00Z",
  "LocalLogRetentionHours" : "18",
  "PreferredNextBackupTime" : "2021-01-07T00:40Z",
  "HighSpaceUsageProtection" : "Enable",
  "CompressType" : "1",
  "LogBackupFrequency" : "LogInterval",
  "PreferredBackupPeriod" : "Tuesday,Thursday,Saturday",
  "ArchiveBackupKeepCount" : 1,
  "LogBackupRetentionPeriod" : "7",
  "LogBackupLocalRetentionNumber" : 60,
  "BackupLog" : "Enable",
  "EnableBackupLog" : "1",
  "SupportReleasedKeep" : 0,
  "SupportVolumeShadowCopy" : 1,
  "LocalLogRetentionSpace" : "30",
  "BackupRetentionPeriod" : 10,
  "DuplicationContent" : "",
  "BackupInterval" : "30"
}

    Kode kesalahan

    Kode status HTTP Kode kesalahan Pesan kesalahan Deskripsi
    400 IO.Exception IO exception, retry later. Pesan kesalahan yang dikembalikan karena terjadi error I/O.
    400 InternalFailure Internal failure, retry later. Pesan kesalahan yang dikembalikan karena permintaan gagal. Coba lagi nanti.
    400 InvalidParameter.OwnerAccount The specified parameter OwnerAccount is not valid. Pesan kesalahan yang dikembalikan karena nilai parameter OwnerAccount tidak valid. Periksa nilainya.
    404 InvalidDBInstance.NotFound Specified instance does not exist or not support. Pesan kesalahan yang dikembalikan karena instans tidak ditemukan, telah dihapus, atau tidak mendukung operasi tersebut.

    Untuk daftar kode kesalahan lengkap, kunjungi API Error Center.