All Products
Search
Document Center

:Ubah pengaturan backup

Last Updated:May 26, 2026

Anda dapat memanggil operasi ModifyBackupPolicy untuk mengubah pengaturan backup instans.

Sebelum memanggil operasi ini, pastikan persyaratan berikut terpenuhi:

  • Instans bukan instans hanya baca.
  • Instans berada dalam status Running.

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 untuk berbagai SDK.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyBackupPolicy

Operasi yang ingin Anda lakukan. Tetapkan nilainya ke ModifyBackupPolicy.

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

ID instans. Anda dapat memanggil operasi DescribeDBInstances untuk menanyakan ID instans.

BackupPolicyMode String No DataBackupPolicy

Jenis backup yang ingin Anda lakukan. Nilai yang valid:

  • DataBackupPolicy: data backup
  • LogBackupPolicy: log backup
PreferredBackupTime String No 00:00Z-01:00Z

Waktu pelaksanaan backup. Tentukan waktu dalam standar ISO 8601 dengan format HH:mmZ-HH:mmZ. Waktu harus dalam UTC.

Catatan
  • Anda harus menentukan parameter ini ketika menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
PreferredBackupPeriod String No Monday

Siklus backup. Tentukan minimal dua hari dalam seminggu dan pisahkan hari-hari tersebut dengan koma (,). Nilai yang valid:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
Catatan
  • Anda dapat mengonfigurasi kebijakan backup menggunakan parameter ini dan parameter BackupInterval. Misalnya, jika Anda menetapkan parameter ini ke Saturday,Sunday dan parameter BackupInterval ke 30, backup akan dilakukan setiap 30 menit pada setiap Sabtu dan Minggu.
  • Anda harus menentukan parameter ini ketika menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
BackupRetentionPeriod String No 7

Jumlah hari penyimpanan file data backup. Nilai yang valid: 7 hingga 730.

Catatan
  • Anda harus menentukan parameter ini ketika menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
BackupLog String No Enable

Menentukan apakah fitur log backup diaktifkan. Nilai yang valid:

  • Enable
  • Disabled
Catatan
  • Anda harus menentukan parameter ini ketika menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
LogBackupRetentionPeriod String No 7

Jumlah hari penyimpanan file log backup. Nilai yang valid: 7 hingga 730. Periode retensi log backup tidak boleh lebih lama daripada periode retensi data backup.

Catatan
  • Jika Anda mengaktifkan fitur log backup, Anda dapat menentukan periode retensi log backup. Parameter ini hanya didukung oleh instans yang menjalankan MySQL dan PostgreSQL.
  • Parameter ini berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy atau LogBackupPolicy.
EnableBackupLog String No 1

Menentukan apakah fitur log backup diaktifkan. Nilai yang valid:

  • True atau 1: Fitur log backup diaktifkan.
  • False atau 0: Fitur log backup dinonaktifkan.
Catatan
  • Anda harus menentukan parameter ini ketika menetapkan parameter BackupPolicyMode ke LogBackupPolicy.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke LogBackupPolicy.
LocalLogRetentionHours String No 18

Jumlah jam penyimpanan file log backup di instans. Nilai yang valid: 0 hingga 168. Nilai 0 berarti file log backup tidak disimpan di instans. Nilai 168 dihitung berdasarkan rumus berikut: 7 × 24.

Catatan
  • Anda harus menentukan parameter ini ketika menetapkan parameter BackupPolicyMode ke LogBackupPolicy.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke LogBackupPolicy.
LocalLogRetentionSpace String No 30

Penggunaan penyimpanan maksimum yang diizinkan untuk file log backup di instans. Jika penggunaan penyimpanan untuk file log backup di instans melebihi nilai parameter ini, ApsaraDB RDS akan menghapus file log backup yang lebih lama hingga penggunaan penyimpanan turun di bawah nilai parameter ini. Nilai yang valid: 0 hingga 50. Anda dapat mempertahankan nilai default.

Catatan
  • Anda harus menentukan parameter ini ketika menetapkan parameter BackupPolicyMode ke LogBackupPolicy.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke LogBackupPolicy.
HighSpaceUsageProtection String No Enable

Menentukan apakah ApsaraDB RDS menghapus paksa file log backup dari instans ketika penggunaan penyimpanan instans melebihi 80% atau ruang penyimpanan tersisa di instans kurang dari 5 GB. Nilai yang valid: Enable dan Disable. Anda dapat mempertahankan nilai default.

Catatan
  • Anda harus menentukan parameter ini ketika menetapkan parameter BackupPolicyMode ke LogBackupPolicy.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke LogBackupPolicy.
LogBackupFrequency String No LogInterval

Frekuensi backup log instans. Nilai yang valid:

  • Nilai LogInterval berarti backup log dilakukan setiap 30 menit.
  • Nilai default sama dengan frekuensi backup data.
Catatan
  • Nilai LogInterval hanya didukung oleh instans yang menjalankan SQL Server.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
CompressType String No 4

Format kompresi backup. Nilai yang valid:

  • 0: Backup tidak dikompresi.
  • 1: Tool zlib digunakan untuk mengompresi backup menjadi file .tar.gz.
  • 2: Tool zlib digunakan untuk mengompresi backup secara paralel.
  • 4: Tool QuickLZ digunakan untuk mengompresi backup menjadi file .xb.gz. Format kompresi ini hanya didukung oleh instans yang menjalankan MySQL 5.6 atau MySQL 5.7. Backup dalam format kompresi ini dapat digunakan untuk memulihkan database dan tabel tertentu. Untuk informasi selengkapnya, lihat Restore individual databases and tables of an ApsaraDB RDS for MySQL instance.
  • 8: Tool QuickLZ digunakan untuk mengompresi backup menjadi file .xb.gz. Format kompresi ini hanya didukung oleh instans yang menjalankan MySQL 8.0. Backup dalam format kompresi ini tidak dapat digunakan untuk memulihkan database dan tabel tertentu.
Catatan Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
ArchiveBackupRetentionPeriod String No 365

Jumlah hari penyimpanan file backup arsip. Nilai default 0 berarti fitur arsip backup tidak diaktifkan. Nilai yang valid: 30 hingga 1095.

Catatan Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
ArchiveBackupKeepPolicy String No ByMonth

Jangka waktu penyimpanan file backup arsip. Jumlah file backup arsip yang dapat disimpan dalam periode retensi yang ditentukan ditentukan oleh parameter ArchiveBackupKeepCount. Nilai default: 0. Nilai yang valid:

  • ByMonth
  • ByWeek
  • KeepAll
Catatan Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
ArchiveBackupKeepCount Integer No 1

Jumlah file backup arsip yang ingin Anda simpan. Nilai default: 1. Nilai yang valid:

  • Nilai parameter ini berkisar antara 1 hingga 31 ketika parameter ArchiveBackupKeepPolicy ditetapkan ke ByMonth.
  • Nilai parameter ini berkisar antara 1 hingga 7 ketika parameter ArchiveBackupKeepPolicy ditetapkan ke ByWeek.
Catatan
  • Anda tidak perlu menentukan parameter ini ketika parameter ArchiveBackupKeepPolicy ditetapkan ke KeepAll.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
ReleasedKeepPolicy String No None

Kebijakan penyimpanan file backup arsip jika instans dilepas. Nilai default: None. Nilai yang valid:

  • None: Tidak ada file backup arsip yang disimpan.
  • Lastest: Hanya file backup arsip terbaru yang disimpan.
  • All: Semua file backup arsip disimpan.
Catatan Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
LogBackupLocalRetentionNumber Integer No 60

Jumlah file log biner yang ingin Anda simpan di instans. Nilai default: 60. Nilai yang valid: 6 hingga 100.

Catatan
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke LogBackupPolicy.
  • Jika instans menjalankan MySQL, Anda dapat menetapkan parameter ini ke -1. Nilai -1 berarti jumlah tak terbatas file log biner dapat disimpan di instans.
Category String No Standard

Menentukan apakah fitur backup dalam hitungan detik diaktifkan. Fitur ini memungkinkan ApsaraDB RDS menyelesaikan backup dalam beberapa detik. Nilai yang valid:

  • Flash: Fitur backup dalam hitungan detik diaktifkan.
  • Standard: Fitur backup dalam hitungan detik dinonaktifkan.
Catatan Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
BackupInterval String No 30

Frekuensi pelaksanaan cadangan snapshot pada instans. Nilai yang valid:

  • -1: Frekuensi backup tidak ditentukan.
  • 30: Cadangan snapshot dilakukan setiap 30 menit.
  • 60: Cadangan snapshot dilakukan setiap 60 menit.
  • 120: Cadangan snapshot dilakukan setiap 120 menit.
  • 240: Cadangan snapshot dilakukan setiap 240 menit.
  • 480: Cadangan snapshot dilakukan setiap 480 menit.
Catatan
  • Anda dapat mengonfigurasi kebijakan backup menggunakan parameter ini dan parameter PreferredBackupPeriod. Misalnya, jika Anda menetapkan parameter PreferredBackupPeriod ke Saturday,Sunday dan parameter BackupInterval ke -1, cadangan snapshot akan dilakukan setiap Sabtu dan Minggu.
  • Jika instans menjalankan PostgreSQL, parameter BackupInterval hanya didukung ketika instans dilengkapi SSD standar atau ESSD.
  • Jika instans menjalankan SQL Server, parameter BackupInterval hanya didukung ketika fitur cadangan snapshot diaktifkan untuk instans. Untuk informasi selengkapnya, lihat Enable snapshot backups for an ApsaraDB RDS for SQL Server instance.
  • Jika Anda menetapkan parameter Category ke Flash, parameter BackupInterval tidak berlaku.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
BackupMethod String No Physical

Metode backup instans. Nilai yang valid:

  • Physical: backup fisik
  • Snapshot: cadangan snapshot

Nilai default: Physical.

Catatan
  • Parameter ini hanya berlaku pada instans yang menjalankan SQL Server dengan SSD standar atau ESSD.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.
EnableIncrementDataBackup Boolean No false

Menentukan apakah fitur cadangan inkremental diaktifkan. Nilai yang valid:

  • false: Fitur cadangan inkremental dinonaktifkan. Nilai default adalah false.
  • true: Fitur cadangan inkremental diaktifkan.
Catatan
  • Parameter ini hanya berlaku pada instans yang menjalankan SQL Server dengan SSD standar atau ESSD.
  • Parameter ini hanya berlaku ketika Anda menetapkan parameter BackupPolicyMode ke DataBackupPolicy.

Response parameters

Parameter Type Example Description
RequestId String DA147739-AEAD-4417-9089-65E9B1D8240D

ID permintaan.

CompressType String 4

Format kompresi backup. Nilai yang valid:

  • 0: Backup tidak dikompresi.
  • 1: Backup dikompresi menggunakan tool zlib.
  • 2: Backup dikompresi secara paralel menggunakan tool zlib.
  • 4: Backup dikompresi menggunakan tool QuickLZ dan dapat digunakan untuk memulihkan database dan tabel tertentu.
  • 8: Backup dikompresi menggunakan tool QuickLZ tetapi tidak dapat digunakan untuk memulihkan database atau tabel tertentu. Nilai ini hanya didukung oleh instans yang menjalankan MySQL 8.0.
LocalLogRetentionSpace String 30

Penggunaan penyimpanan maksimum yang diizinkan untuk file log backup di instans.

LogBackupLocalRetentionNumber Integer 60

Jumlah file log biner yang disimpan di instans.

DBInstanceID String rm-uf6wjk5xxxxxxx

ID instans.

EnableBackupLog String 1

Menunjukkan apakah fitur log backup diaktifkan. Nilai yang valid:

  • 1: Fitur log backup diaktifkan.
  • 0: Fitur log backup dinonaktifkan.
LocalLogRetentionHours Integer 18

Jumlah jam penyimpanan file log backup di instans.

HighSpaceUsageProtection String Disable

Menunjukkan apakah ApsaraDB RDS menghapus paksa file log backup dari instans ketika penggunaan penyimpanan instans melebihi 80% atau ruang penyimpanan tersisa di instans kurang dari 5 GB.

Examples

Contoh permintaan

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

Contoh respons sukses

XML format

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

<ModifyBackupPolicyResponse>
      <HighSpaceUsageProtection>Disable</HighSpaceUsageProtection>
	<DBInstanceID>rm-bp1z3xxxxx</DBInstanceID>
	<RequestId>E4BF5598-ED12-4406-AAA4-F375428BE741</RequestId>
	<LocalLogRetentionHours>18</LocalLogRetentionHours>
	<EnableBackupLog>1</EnableBackupLog>
	<LocalLogRetentionSpace>30</LocalLogRetentionSpace>
    <LogBackupLocalRetentionNumber>60</LogBackupLocalRetentionNumber>
</ModifyBackupPolicyResponse>

JSON format

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

{
  "HighSpaceUsageProtection" : "Disable",
  "DBInstanceID" : "rm-bp1z3xxxxx",
  "RequestId" : "E4BF5598-ED12-4406-AAA4-F375428BE741",
  "LocalLogRetentionHours" : "18",
  "EnableBackupLog" : "1",
  "LocalLogRetentionSpace" : "30",
  "LogBackupLocalRetentionNumber" : 60
}

Error codes

HTTP status code Error code Error message Description
400 InvalidLogBackupFrequency.Malformed Invalid log backup frequency. Pesan kesalahan yang dikembalikan karena nilai parameter LogBackupFrequency tidak valid. Periksa apakah pengaturan parameter sudah benar.
400 InvalidBackupRetentionPeriod.Malformed The specified backup retention period is invalid. Pesan kesalahan yang dikembalikan karena periode retensi backup tidak ditentukan. Tentukan periode retensi backup. Periode retensi backup tidak boleh kurang dari 1 hari atau lebih dari 30 hari.
400 BackupPropertyNotFound Backup policy not found Pesan kesalahan yang dikembalikan karena kebijakan backup tidak ditemukan.
400 OperationDenied.SwitchToSnapshot Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode. Pesan kesalahan yang dikembalikan karena file cadangan snapshot tidak dapat disimpan di wilayah yang berbeda dari wilayah tempat instans berada. Sebelum mengaktifkan fitur cadangan snapshot, Anda harus menonaktifkan fitur cadangan cross-region.
403 IncorrectCategory Current Instance type does not support Category. Pesan kesalahan yang dikembalikan karena parameter Category tidak didukung oleh tipe instans saat ini.
403 OperationDenied.SwitchSnapshotToPhysical Only physical backup to snapshot backup is supported. Pesan kesalahan yang dikembalikan karena operasi hanya mendukung perubahan dari metode backup fisik ke metode cadangan snapshot.
403 OperationDenied.ModifyBackupSwitchOff The switch is not turned on. It is forbidden to modify the backup mode. Pesan kesalahan yang dikembalikan karena fitur cadangan cross-region tidak diaktifkan.
403 OperationDenied.ApiForbiddenForLogBackupFrequency When the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup. Pesan kesalahan yang dikembalikan karena frekuensi log backup tidak boleh sama dengan frekuensi backup data ketika fitur cadangan snapshot diaktifkan.
403 OperationDenied.NotSupportedBackupMethod When the storage is larger than 4000 GB, only snapshot backup is supported. Pesan kesalahan yang dikembalikan karena instans hanya mendukung cadangan snapshot ketika penyimpanan lebih besar dari 4.000 GB.
403 OperationDenied.ApiForbidden Operation is not permitted. Pesan kesalahan yang dikembalikan karena operasi tidak diizinkan.

Untuk daftar kode kesalahan, kunjungi API Error Center.