All Products
Search
Document Center

Data Management:ModifyBackupPolicy

Last Updated:Jun 23, 2026

Mengubah kebijakan cadangan instans PolarDB Basis Data Relasional Cloud-Native.

Deskripsi operasi

Mesin yang berlaku

PolarDB Basis Data Relasional Cloud-Native for MySQL

Catatan

Operasi ini saat ini hanya tersedia untuk pelanggan tertentu. Untuk menggunakan operasi ini, kirimkan permintaan di kelompok konsultasi pelanggan DBS (ID kelompok DingTalk: 35585947).

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

dbs:ModifyBackupPolicy

update

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

RegionCode

string

No

Wilayah tempat set cadangan berada.

cn-shanghai

PreferredBackupWindowBegin

string

No

Pengatur waktu mulai jendela cadangan dasar.

17:00Z

InstanceName

string

No

ID instans PolarDB Basis Data Relasional Cloud-Native.

pc-2ze3nrr64c5****

Category

string

No

Jenis cadangan. Nilai valid:

  • Flash: cadangan dalam hitungan detik

  • Standard: cadangan dasar.

Flash

AdvanceLogPolicies

array<object>

No

Wilayah tujuan kebijakan cadangan.

object

No

Wilayah sumber kebijakan cadangan.

LogRetentionType

string

No

Jenis periode retensi. Nilai valid:

  • Never: tidak pernah kedaluwarsa

  • Delay: kedaluwarsa setelah jumlah hari tertentu.

Never

DestType

string

No

Jenis tujuan kebijakan cadangan. Nilai valid:

  • db: database

  • level1: cadangan utama

  • level2: cadangan sekunder

  • level2Cross: cadangan sekunder lintas wilayah.

level1

FilterType

string

No

Jenis filter kebijakan lanjutan. Nilai valid:

  • Crontab: penjadwalan periode

  • Event: penjadwalan berbasis event.

crontab

ActionType

string

No

Jenis operasi. Nilai valid: CREATE, UPDATE, dan DELETE.

CREATE

SrcRegion

string

No

Wilayah sumber kebijakan cadangan.

cn-hangzhou

EnableLogBackup

integer

No

Apakah akan mengaktifkan cadangan log. Nilai valid:

  • 1: Diaktifkan.

  • 0: Dinonaktifkan.

1

SrcType

string

No

Jenis sumber kebijakan cadangan. Nilai valid:

  • db: database

  • level1: cadangan utama

  • level2: cadangan sekunder

  • level2Cross: cadangan sekunder lintas wilayah.

db

LogRetentionValue

string

No

Jumlah hari sebelum kedaluwarsa.

30

PolicyId

string

No

ID kebijakan lanjutan.

31289676-bb8d-4dee-b83e-******

FilterKey

string

No

Jenis penjadwalan. Parameter ini hanya valid ketika FilterType diatur ke crontab. Nilai valid:

  • dayOfWeek: penjadwalan mingguan

  • dayOfMonth: penjadwalan bulanan

  • dayOfYear: penjadwalan tahunan

  • backupInterval: penjadwalan interval tetap.

dayOfMonth

DestRegion

string

No

Wilayah tujuan kebijakan cadangan.

cn-hangzhou

FilterValue

string

No

Nilai filter spesifik.

1

AdvanceDataPolicies

array<object>

No

Detail kebijakan cadangan data.

object

No

Detail kebijakan.

DestType

string

No

Jenis tujuan kebijakan cadangan. Nilai valid:

  • db: database

  • level1: cadangan utama

  • level2: cadangan sekunder

  • level2Cross: cadangan sekunder lintas wilayah.

level1

FilterType

string

No

Jenis filter kebijakan lanjutan. Nilai valid:

  • crontab: penjadwalan periode

  • event: penjadwalan berbasis event.

crontab

ActionType

string

No

Jenis operasi. Nilai valid:

  • CREATE: Membuat.

  • UPDATE: Memperbarui.

  • DELETE: Menghapus.

UPDATE

SrcRegion

string

No

Wilayah sumber kebijakan cadangan.

cn-shanghai

SrcType

string

No

Jenis sumber kebijakan cadangan. Nilai valid:

  • db: database

  • level1: cadangan utama

  • level2: cadangan sekunder

  • level2Cross: cadangan sekunder lintas wilayah.

db

OnlyPreserveOneEachDay

boolean

No

Apakah akan mempertahankan hanya satu set cadangan frekuensi tinggi per hari untuk cadangan yang lebih lama dari satu hari.

true

RetentionValue

string

No

Jumlah hari sebelum kedaluwarsa.

4

PolicyId

string

No

ID kebijakan lanjutan. Anda dapat memanggil DescribeBackupPolicy untuk mengkueri nilai ini.

6s67c7i3y8f8p72808p******

FilterKey

string

No

Jenis penjadwalan. Nilai valid:

  • dayOfWeek: penjadwalan mingguan

  • dayOfMonth: penjadwalan bulanan

  • dayOfYear: penjadwalan tahunan

  • backupInterval: penjadwalan interval tetap

Catatan

Parameter ini hanya dikembalikan ketika FilterType diatur ke crontab.

backupInterval

DestRegion

string

No

Wilayah tujuan kebijakan cadangan.

cn-shanghai

FilterValue

string

No

Siklus cadangan.

180

RetentionType

string

No

Jenis periode retensi set cadangan. Nilai valid:

  • never: Tidak pernah kedaluwarsa.

  • delay: Kedaluwarsa setelah jumlah hari tertentu.

delay

StorageClass

string

No

Kelas penyimpanan bucket. Nilai valid:

  • Standard (default): Jenis Penyimpanan Standar.

  • IA: Penyimpanan Akses Jarang.

  • Archive: Penyimpanan Arsip.

  • ColdArchive: Penyimpanan Arsip Dingin.

  • DeepColdArchive: Penyimpanan Arsip Dingin Mendalam.

Standard

AdvanceIncPolicies

array<object>

No

Wilayah tujuan kebijakan cadangan.

object

No

Wilayah sumber kebijakan cadangan.

DestType

string

No

Jenis tujuan kebijakan cadangan. Nilai valid:

  • db: database

  • level1: cadangan utama

  • level2: cadangan sekunder

  • level2Cross: cadangan sekunder lintas wilayah.

level1

FilterType

string

No

Jenis filter kebijakan lanjutan. Nilai valid:

  • Crontab: penjadwalan periode

  • Event: penjadwalan berbasis event.

crontab

ActionType

string

No

Jenis operasi. Nilai valid: CREATE, UPDATE, dan DELETE.

CREATE

SrcRegion

string

No

Wilayah sumber kebijakan cadangan.

cn-hangzhou

SrcType

string

No

Jenis sumber kebijakan cadangan. Nilai valid:

  • db: database

  • level1: cadangan utama

  • level2: cadangan sekunder

  • level2Cross: cadangan sekunder lintas wilayah.

db

OnlyPreserveOneEachDay

boolean

No

Apakah akan mempertahankan hanya satu set cadangan frekuensi tinggi per hari untuk cadangan yang lebih lama dari satu hari.

true

RetentionValue

string

No

Jumlah hari sebelum kedaluwarsa.

365

PolicyId

string

No

ID kebijakan lanjutan.

1

FilterKey

string

No

Jenis penjadwalan. Parameter ini hanya valid ketika FilterType diatur ke crontab. Nilai valid:

  • dayOfWeek: penjadwalan mingguan

  • dayOfMonth: penjadwalan bulanan

  • dayOfYear: penjadwalan tahunan

  • backupInterval: penjadwalan interval tetap.

dayOfMonth

DestRegion

string

No

Wilayah tujuan kebijakan cadangan.

cn-hangzhou

FilterValue

string

No

Nilai filter spesifik.

1

RetentionType

string

No

Jenis periode retensi. Nilai valid:

  • Never: tidak pernah kedaluwarsa

  • Delay: kedaluwarsa setelah jumlah hari tertentu.

delay

BackupRetentionPolicyOnClusterDeletion

string

No

Kebijakan retensi data cadangan arsip untuk instans yang dihapus. Nilai valid:

  • NONE: Tidak dipertahankan.

  • LATEST: Hanya cadangan terakhir yang dipertahankan.

  • ALL: Semua cadangan dipertahankan.

0

BackupMethod

string

No

Metode cadangan. Nilai valid:

  • logical: cadangan logis

  • physical: cadangan fisik.

logical

BackupPriority

integer

No

Kebijakan cadangan untuk instans sekunder. Nilai valid:

  • 1: Instans sekunder diutamakan.

  • 2: Instans utama dipaksa.

Catatan

Parameter ini hanya berlaku untuk instans ApsaraDB RDS for SQL Server. Untuk mesin lainnya, nilai 0 dikembalikan.

2

EnableIncBackup

boolean

No

Apakah akan mengaktifkan cadangan inkremental.

true

Elemen respons

Element

Type

Description

Example

object

Parameter tanggapan.

RequestId

string

ID permintaan.

D570F209-A166-50C6-98A3-155A20B218B7

Message

string

Paket yang dikembalikan.

instanceName can not be empty.

Data

object

Detail kebijakan cadangan.

PreferredBackupWindowBegin

string

Pengatur waktu mulai jendela cadangan dasar.

17:00Z

PreferredBackupWindow

string

Jendela cadangan dasar.

17:00Z-18:00Z

Category

string

Menunjukkan apakah cadangan dalam hitungan detik diaktifkan. Nilai valid:

  • Flash: Cadangan dalam hitungan detik diaktifkan.

  • Standard: Cadangan dasar.

Catatan

Parameter ini hanya berlaku untuk MySQL.

Standard

AdvanceLogPolicies

array<object>

Detail kebijakan.

object

Detail kebijakan.

LogRetentionType

string

The retention type for log backups. Valid values:

delay

DestType

string

The destination type of the backup policy. Valid values:

level1

FilterType

string

The filter type for the advanced policy. Valid values:

  • crontab: Recurring schedule.

  • event: Event-based schedule.

crontab

SrcRegion

string

The source region of the backup policy.

cn-beijing

EnableLogBackup

integer

This parameter is reserved.

1

SrcType

string

The source type of the backup policy. Valid values:

level1

PolicyId

string

The ID of the backup policy.

dc13b153acc91141789122c23835****

DestRegion

string

The destination region of the backup policy.

cn-shanghai

LogRetentionValue

string

The retention period for log backups, in days.

3

FilterKey

string

The scheduling type. This parameter applies only when FilterType is set to crontab. Valid values:

dayOfMonth

FilterValue

string

The value of the filter.

1

AdvanceDataPolicies

array<object>

Detail kebijakan cadangan data.

object

Detail kebijakan.

RetentionValue

string

The retention period in days.

4

BakType

string

The backup type. Valid values:

  • F: Full backup.

  • L: Log backup.

F

FilterKey

string

The scheduling type. Valid values:

  • dayOfWeek: Weekly schedule.

  • dayOfMonth: Monthly schedule.

  • dayOfYear: Yearly schedule.

  • backupInterval: Fixed interval schedule.

Catatan

This parameter is returned only if FilterType is set to crontab.

backupInterval

FilterValue

string

The value of the filter.

180

DestType

string

The destination type of the backup policy. Valid values:

  • db: Database

  • level1: level-1 backup

  • level2: level-2 backup

  • level2Cross: level-2 cross-region backup

level1

FilterType

string

The filter type for the advanced policy. Valid values:

  • crontab: Recurring schedule.

  • event: Event-based schedule.

crontab

SrcRegion

string

The source region of the backup policy.

cn-shanghai

AutoCreated

boolean

Specifies whether the policy is automatically generated by the system. Valid values:

  • true: The policy is generated by the system.

  • false: The policy is a custom policy.

false

SrcType

string

The source type of the backup policy. Valid values:

  • db: Database

  • level1: level-1 backup

  • level2: level-2 backup

  • level2Cross: level-2 cross-region backup

db

OnlyPreserveOneEachDay

boolean

Specifies whether to retain only one backup set per day. Valid values:

  • true: Only one backup set is retained per day.

  • false: All backup sets are retained.

true

DumpAction

string

The dump operation. Valid values:

  • copy: Copy

  • move: Move

copy

PolicyId

string

The ID of the advanced policy.

dc13b153acc91141789122c23835****

DestRegion

string

The destination region of the backup policy.

cn-shanghai

RetentionType

string

The retention period type for the backup set. Valid values:

  • Never: The backup set never expires.

  • Delay: The backup set expires after a specified number of days.

delay

StorageClass

string

The storage class.

ARCHIVE

AdvanceIncPolicies

array<object>

Jenis periode retensi. Nilai valid:

  • Never: tidak pernah kedaluwarsa

  • Delay: kedaluwarsa setelah jumlah hari tertentu.

object

Jenis tujuan kebijakan cadangan. Nilai valid:

  • db: database

  • level1: cadangan utama

  • level2: cadangan sekunder

  • level2Cross: cadangan sekunder lintas wilayah.

RetentionValue

string

The retention period in days.

365

BakType

string

The backup type. Valid values:

F

FilterKey

string

The scheduling type. This parameter applies only when FilterType is set to crontab. Valid values:

dayOfMonth

FilterValue

string

The value of the filter.

1

DestType

string

The destination type of the backup policy. Valid values:

level1

FilterType

string

The filter type for the advanced policy. Valid values:

Crontab

SrcRegion

string

The source region of the backup policy.

cn-hangzhou

AutoCreated

boolean

Indicates whether the policy is automatically generated by the system. Valid values:

true

SrcType

string

The source type of the backup policy. Valid values:

db

OnlyPreserveOneEachDay

boolean

Specifies whether to retain only one backup set per day. Valid values:

  • true: Only one backup set is retained per day.

  • false: All backup sets are retained.

true

DumpAction

string

The dump operation. Valid values:

Copy

PolicyId

string

The ID of the advanced policy.

smp-8sv763r9boydzb***

DestRegion

string

The destination region of the backup policy.

cn-hangzhou

RetentionType

string

The retention period type for the backup set. Valid values:

Delay

BackupRetentionPolicyOnClusterDeletion

string

Kebijakan retensi data cadangan arsip untuk instans yang dihapus. Nilai valid:

  • NONE: Tidak dipertahankan.

  • LATEST: Hanya cadangan terakhir yang dipertahankan.

  • ALL: Semua cadangan dipertahankan.

LATEST

BackupMethod

string

Metode cadangan. Nilai valid:

  • Physical: cadangan fisik

  • Snapshot: cadangan snapshot.

Physical

BackupPriority

integer

Kebijakan cadangan untuk instans sekunder. Nilai valid:

  • 1: Instans sekunder diutamakan.

  • 2: Instans utama dipaksa.

Catatan

Parameter ini hanya berlaku untuk instans ApsaraDB RDS for SQL Server. Untuk mesin lainnya, nilai 0 dikembalikan.

1

EnableIncBackup

boolean

Apakah akan mengaktifkan cadangan inkremental.

true

ErrMessage

string

Paket kesalahan.

The specified parameter %s value is not valid.

Code

string

Kode status.

Success

Success

string

Menunjukkan apakah permintaan berhasil. Nilai valid:

  • true: Permintaan berhasil.

  • false: Permintaan gagal.

true

ErrCode

string

Kode kesalahan.

Success

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D570F209-A166-50C6-98A3-155A20B218B7",
  "Message": "instanceName can not be empty.",
  "Data": {
    "PreferredBackupWindowBegin": "17:00Z",
    "PreferredBackupWindow": "17:00Z-18:00Z",
    "Category": "Standard",
    "AdvanceLogPolicies": [
      {
        "LogRetentionType": "delay",
        "DestType": "level1",
        "FilterType": "crontab",
        "SrcRegion": "cn-beijing",
        "EnableLogBackup": 1,
        "SrcType": "level1",
        "PolicyId": "dc13b153acc91141789122c23835****",
        "DestRegion": "cn-shanghai",
        "LogRetentionValue": "3",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1"
      }
    ],
    "AdvanceDataPolicies": [
      {
        "RetentionValue": "4",
        "BakType": "F",
        "FilterKey": "backupInterval",
        "FilterValue": "180",
        "DestType": "level1",
        "FilterType": "crontab",
        "SrcRegion": "cn-shanghai",
        "AutoCreated": false,
        "SrcType": "db",
        "OnlyPreserveOneEachDay": true,
        "DumpAction": "copy",
        "PolicyId": "dc13b153acc91141789122c23835****",
        "DestRegion": "cn-shanghai",
        "RetentionType": "delay",
        "StorageClass": "ARCHIVE"
      }
    ],
    "AdvanceIncPolicies": [
      {
        "RetentionValue": "365",
        "BakType": "F",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1",
        "DestType": "level1",
        "FilterType": "Crontab",
        "SrcRegion": "cn-hangzhou",
        "AutoCreated": true,
        "SrcType": "db",
        "OnlyPreserveOneEachDay": true,
        "DumpAction": "Copy",
        "PolicyId": "smp-8sv763r9boydzb***",
        "DestRegion": "cn-hangzhou",
        "RetentionType": "Delay"
      }
    ],
    "BackupRetentionPolicyOnClusterDeletion": "LATEST",
    "BackupMethod": "Physical",
    "BackupPriority": 1,
    "EnableIncBackup": true
  },
  "ErrMessage": "The specified parameter %s value is not valid.",
  "Code": "Success",
  "Success": "true",
  "ErrCode": "Success"
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

403 Request.Forbidden Have no Permissions

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.