All Products
Search

This Product

    PolarDB:DescribeBackupPolicy

    Document Center

    PolarDB:DescribeBackupPolicy

    Last Updated:Sep 09, 2026

    Mengkueri kebijakan cadangan otomatis kluster PolarDB Basis Data Relasional 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

    polardb:DescribeBackupPolicy

    get

    *Kluster.

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    ID kluster.

    Catatan

    Anda dapat memanggil operasi DescribeDBClusters untuk mengkueri informasi semua kluster di wilayah tertentu, termasuk ID kluster.

    pc-*************

    Elemen respons

    Element

    Type

    Description

    Example

    object

    AdvancedDataPolicies

    object

    AdvancedDataPolicy

    array<object>

    Detail kebijakan cadangan lanjutan.

    Catatan

    • Parameter ini tidak didukung untuk PolarDB Basis Data Relasional Cloud-Native for PostgreSQL (Compatible with Oracle) atau PolarDB Basis Data Relasional Cloud-Native for PostgreSQL.

    object

    AutoCreated

    boolean

    Apakah kebijakan cadangan dibuat secara otomatis oleh sistem. Nilai valid:

    • true: Kebijakan dibuat oleh sistem.

    • false: Kebijakan ditentukan pengguna.

    true
    BakType

    string

    Jenis cadangan. Nilai valid:

    • F: cadangan penuh.

    F
    DestRegion

    string

    Wilayah tujuan kebijakan cadangan.

    cn-hangzhou
    DestType

    string

    Jenis tujuan kebijakan cadangan. Nilai valid:

    • level1: cadangan level-1

    • level2: cadangan level-2

    • level2Cross: cadangan level-2 lintas wilayah

    level1
    DumpAction

    string

    Metode yang digunakan untuk mengonversi cadangan level-1 menjadi cadangan level-2. Nilai valid:

    • copy: copy

    copy
    FilterKey

    string

    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.

    dayOfWeek
    FilterType

    string

    Jenis filter kebijakan lanjutan. Nilai valid:

    • crontab: penjadwalan berkala

    • event: penjadwalan berbasis event

    crontab
    FilterValue

    string

    Siklus cadangan.

    1,2,3,4,5,6,7
    OnlyPreserveOneEachDay

    boolean

    Kebijakan retensi data cadangan 24 jam. Nilai valid:

    • true: Hanya set cadangan pertama hari itu yang dipertahankan untuk cadangan yang lebih lama dari 24 jam.

    • false: Semua set cadangan dipertahankan.

    true
    OnlyPreserveOneEachHour

    boolean

    Kebijakan retensi data cadangan per jam. Nilai valid:

    • true: Hanya set cadangan paling awal dalam setiap jam yang dipertahankan untuk cadangan yang lebih lama dari 1 jam.

    • false: Semua set cadangan dipertahankan.

    true
    PolicyId

    string

    ID kebijakan cadangan.

    71930ac2e9f15e41615e10627c******

    RetentionType

    string

    Jenis retensi set cadangan. Nilai valid:

    • never: retensi jangka panjang (LTR)

    • delay: retensi untuk jumlah hari tetap

    delay
    RetentionValue

    string

    Jumlah hari cadangan dipertahankan.

    7
    SrcRegion

    string

    Wilayah sumber kebijakan cadangan.

    cn-beijing
    SrcType

    string

    Jenis sumber kebijakan cadangan. Nilai valid:

    • db: kluster database

    • level1: cadangan level-1

    • level2: cadangan level-2

    • level2Cross: cadangan level-2 lintas wilayah

    level1
    StorageClass

    string

    AdvancedPolicyOption

    string

    Opsi kebijakan cadangan lanjutan. Nilai valid:

    • enable: Cadangan lanjutan diaktifkan.

    • disable: Cadangan lanjutan tidak diaktifkan tetapi dapat diaktifkan.

    • notSupport: Cadangan lanjutan tidak didukung.

    Catatan

    • Parameter ini tidak didukung untuk PolarDB Basis Data Relasional Cloud-Native for PostgreSQL (Compatible with Oracle) atau PolarDB Basis Data Relasional Cloud-Native for PostgreSQL.

    disable
    BackupFrequency

    string

    Frekuensi cadangan. Nilai valid:

    • Normal (default): cadangan reguler. Cadangan dilakukan sekali sehari pada waktu yang dijadwalkan.

    • 2/24H: cadangan ditingkatkan. Cadangan dilakukan setiap 2 jam.

    • 3/24H: cadangan ditingkatkan. Cadangan dilakukan setiap 3 jam.

    • 4/24H: cadangan ditingkatkan. Cadangan dilakukan setiap 4 jam.

    Catatan

    • Setelah cadangan ditingkatkan diaktifkan, semua cadangan yang selesai dalam 24 jam dipertahankan. Untuk cadangan yang lebih lama dari 24 jam, hanya cadangan pertama yang selesai setelah pukul 00:00 setiap hari yang dipertahankan, dan lainnya dihapus.

    • Setelah cadangan ditingkatkan diaktifkan, parameter siklus cadangan PreferredBackupPeriod diatur ke semua hari dalam seminggu secara default (Senin hingga Minggu).

    Normal
    BackupPolicyLevel

    string

    Tingkat kebijakan cadangan saat ini. Nilai valid:

    • Normal: cadangan reguler

    • Advanced: cadangan lanjutan

    Catatan

    • Parameter ini tidak didukung untuk PolarDB Basis Data Relasional Cloud-Native for PostgreSQL (Compatible with Oracle) atau PolarDB Basis Data Relasional Cloud-Native for PostgreSQL.

    Normal
    BackupRetentionPolicyOnClusterDeletion

    string

    Apakah akan mempertahankan cadangan saat kluster dihapus. Nilai valid:

    • ALL: Semua cadangan dipertahankan dengan retensi jangka panjang (LTR).

    • LATEST: Cadangan terakhir dipertahankan dengan retensi jangka panjang (LTR).

    • NONE (default): Tidak ada cadangan yang dipertahankan.

    NONE
    DataLevel1BackupFrequency

    string

    Frekuensi cadangan. Nilai valid:

    • Normal (default): cadangan reguler. Cadangan dilakukan sekali sehari pada waktu yang dijadwalkan.

    • 2/24H: cadangan frekuensi tinggi. Cadangan dilakukan setiap 2 jam.

    • 3/24H: cadangan frekuensi tinggi. Cadangan dilakukan setiap 3 jam.

    • 4/24H: cadangan frekuensi tinggi. Cadangan dilakukan setiap 4 jam.

    Catatan

      • Parameter ini tidak didukung untuk PolarDB Basis Data Relasional Cloud-Native for PostgreSQL (Compatible with Oracle) atau PolarDB Basis Data Relasional Cloud-Native for PostgreSQL.

      • Jika wilayah kluster PolarDB Basis Data Relasional Cloud-Native for MySQL Anda tidak mendukung fitur cadangan lintas wilayah, parameter ini tidak didukung. Untuk wilayah yang mendukung cadangan lintas wilayah, lihat Ikhtisar.

      • Setelah cadangan lanjutan diaktifkan, gunakan parameter AdvancedDataPolicies sebagai pengganti parameter ini.

    Normal
    DataLevel1BackupPeriod

    string

    Siklus cadangan level-1. Nilai valid:

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Catatan

      • Minimal dua hari harus dipilih. Pisahkan beberapa nilai dengan koma (,).

      • Parameter ini tidak didukung untuk PolarDB Basis Data Relasional Cloud-Native for PostgreSQL (Compatible with Oracle) atau PolarDB Basis Data Relasional Cloud-Native for PostgreSQL.

      • Jika wilayah kluster PolarDB Basis Data Relasional Cloud-Native for MySQL Anda tidak mendukung fitur cadangan lintas wilayah, parameter ini tidak didukung. Untuk wilayah yang mendukung cadangan lintas wilayah, lihat Ikhtisar.

      • Setelah cadangan lanjutan diaktifkan, gunakan parameter AdvancedDataPolicies sebagai pengganti parameter ini.

    Monday,Tuesday
    DataLevel1BackupRetentionPeriod

    string

    Periode retensi cadangan level-1. Nilai valid: 3 hingga 14. Unit: days.

    Catatan

    Setelah cadangan lanjutan diaktifkan, gunakan parameter AdvancedDataPolicies sebagai pengganti parameter ini.

    7
    DataLevel1BackupTime

    string

    Periode waktu saat cadangan otomatis dilakukan. Nilai dalam format hh:mmZ-hh:mmZ (UTC). Waktu mulai dan akhir harus tepat pada jam dan berjarak tepat 1 jam. Contoh: 14:00Z-15:00Z.

    Catatan

    • Parameter ini tidak didukung untuk PolarDB Basis Data Relasional Cloud-Native for PostgreSQL (Compatible with Oracle) atau PolarDB Basis Data Relasional Cloud-Native for PostgreSQL.

    • Jika wilayah kluster PolarDB Basis Data Relasional Cloud-Native for MySQL Anda tidak mendukung fitur cadangan lintas wilayah, parameter ini tidak didukung. Untuk wilayah yang mendukung cadangan lintas wilayah, lihat Ikhtisar.

    15:00Z-16:00Z
    DataLevel2BackupAnotherRegionRegion

    string

    Wilayah cadangan lintas wilayah untuk cadangan level-2. Untuk wilayah yang mendukung cadangan lintas wilayah, lihat Ikhtisar.

    Catatan

    Setelah cadangan lanjutan diaktifkan, gunakan parameter AdvancedDataPolicies sebagai pengganti parameter ini.

    cn-hangzhou
    DataLevel2BackupAnotherRegionRetentionPeriod

    string

    Epoch retensi cadangan lintas wilayah untuk cadangan level-2. Nilai valid:

    • 0: Fitur cadangan level-2 dinonaktifkan.

    • 30 hingga 7300: Epoch retensi cadangan level-2. Unit: days.

    • -1: Cadangan level-2 dipertahankan dengan retensi jangka panjang (LTR).

    Catatan

      • Saat kluster dibuat, nilai default adalah 0, yang berarti fitur cadangan lintas wilayah untuk cadangan level-2 dinonaktifkan.

      • Setelah cadangan lanjutan diaktifkan, gunakan parameter AdvancedDataPolicies sebagai pengganti parameter ini.

    30
    DataLevel2BackupPeriod

    string

    Siklus cadangan level-2. Nilai valid:

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Catatan

      • Minimal dua hari harus dipilih. Pisahkan beberapa nilai dengan koma (,).

      • Parameter ini tidak didukung untuk PolarDB Basis Data Relasional Cloud-Native for PostgreSQL (Compatible with Oracle) atau PolarDB Basis Data Relasional Cloud-Native for PostgreSQL.

      • Jika wilayah kluster PolarDB Basis Data Relasional Cloud-Native for MySQL Anda tidak mendukung fitur cadangan lintas wilayah, parameter ini tidak didukung. Untuk wilayah yang mendukung cadangan lintas wilayah, lihat Ikhtisar.

      • Setelah cadangan lanjutan diaktifkan, gunakan parameter AdvancedDataPolicies sebagai pengganti parameter ini.

    Monday,Tuesday
    DataLevel2BackupRetentionPeriod

    string

    Epoch retensi cadangan level-2. Nilai valid:

    • 0: Fitur cadangan level-2 dinonaktifkan.

    • 30 hingga 7300: Epoch retensi cadangan level-2. Unit: days.

    • -1: Cadangan level-2 dipertahankan dengan retensi jangka panjang (LTR).

    Catatan

      • Saat kluster dibuat, nilai default adalah 0, yang berarti fitur cadangan level-2 dinonaktifkan.

      • Setelah cadangan lanjutan diaktifkan, gunakan parameter AdvancedDataPolicies sebagai pengganti parameter ini.

    0
    EnableCrossRegionImmutableBackup

    boolean

    Apakah cadangan lintas wilayah tidak dapat diubah diaktifkan.

    EnableImmutableBackup

    boolean

    Apakah cadangan tidak dapat diubah diaktifkan.

    PreferredBackupPeriod

    string

    Siklus cadangan data. Nilai valid:

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Catatan

    Setelah cadangan lanjutan diaktifkan, gunakan parameter AdvancedDataPolicies sebagai pengganti parameter ini.

    Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
    PreferredBackupTime

    string

    Periode waktu saat cadangan otomatis dilakukan. Nilai dalam format HH:mmZ-HH:mmZ (UTC).

    07:00Z-08:00Z
    PreferredNextBackupTime

    string

    Waktu cadangan berikutnya. Nilai dalam format YYYY-MM-DDThh:mmZ (UTC).

    2020-11-16T07:30Z
    RequestId

    string

    ID permintaan.

    EADFCE0F-9FB5-4685-B395-1440B******

    Contoh

    Respons sukses

    JSONformat

    {
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "AutoCreated": true,
        "BakType": "F",
        "DestRegion": "cn-hangzhou",
        "DestType": "level1",
        "DumpAction": "copy",
        "FilterKey": "dayOfWeek",
        "FilterType": "crontab",
        "FilterValue": "1,2,3,4,5,6,7",
        "OnlyPreserveOneEachDay": true,
        "OnlyPreserveOneEachHour": true,
        "PolicyId": "71930ac2e9f15e41615e10627c******\n",
        "RetentionType": "delay",
        "RetentionValue": "7",
        "SrcRegion": "cn-beijing",
        "SrcType": "level1",
        "StorageClass": ""
      }
    ]
  },
  "AdvancedPolicyOption": "disable",
  "BackupFrequency": "Normal",
  "BackupPolicyLevel": "Normal",
  "BackupRetentionPolicyOnClusterDeletion": "NONE",
  "DataLevel1BackupFrequency": "Normal",
  "DataLevel1BackupPeriod": "Monday,Tuesday",
  "DataLevel1BackupRetentionPeriod": "7",
  "DataLevel1BackupTime": "15:00Z-16:00Z",
  "DataLevel2BackupAnotherRegionRegion": "cn-hangzhou",
  "DataLevel2BackupAnotherRegionRetentionPeriod": "30",
  "DataLevel2BackupPeriod": "Monday,Tuesday",
  "DataLevel2BackupRetentionPeriod": "0",
  "EnableCrossRegionImmutableBackup": false,
  "EnableImmutableBackup": false,
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "PreferredBackupTime": "07:00Z-08:00Z",
  "PreferredNextBackupTime": "2020-11-16T07:30Z",
  "RequestId": "EADFCE0F-9FB5-4685-B395-1440B******"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. Operasi gagal karena ID instans kluster yang ditentukan tidak ada.
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. DBClusterId yang diberikan tidak ada dalam catatan saat ini.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.