All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeAdvancedBackupPolicy

    Document Center

    ApsaraDB for MongoDB:DescribeAdvancedBackupPolicy

    Last Updated:Sep 23, 2026

    Mengkueri kebijakan cadangan lanjutan.

    Deskripsi operasi

    Mengkueri kebijakan cadangan lanjutan. Operasi ini hanya mendukung instans replika set cloud disk dan instans kluster sharded cloud disk.

    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

    dds:DescribeAdvancedBackupPolicy

    get

    *Instans.

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceId

    string

    Yes

    ID instans.

    dds-bp18b0934e70****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    ID permintaan.

    111E7B16-0A87-4CBA-B271-F34AD61E099F
    DBInstanceId

    string

    ID instans.

    dds-bp14bf67a76d****
    PreferredBackupTime

    string

    Pengatur waktu cadangan dalam format HH:mmZ-HH:mmZ (UTC).

    09:00Z-10:00Z
    SnapshotBackupType

    string

    Tipe cadangan snapshot. Nilai valid:

    • Flash: cadangan dalam hitungan detik.

    • Standard: Jenis Penyimpanan Standar.

    Valid values:

    • Standard :

      Jenis Penyimpanan Standar.

    • Flash :

      Cadangan dalam hitungan detik.

    Standard
    BackupRetentionPolicyOnClusterDeletion

    integer

    Kata kunci retensi data cadangan. Nilai valid:

    • 0: Semua set cadangan segera dihapus saat instans dilepas.

    • 1: Set cadangan terakhir disimpan untuk Kata kunci jangka panjang (LTR) saat instans dilepas.

    • 2: Semua set cadangan disimpan untuk Kata kunci jangka panjang (LTR) saat instans dilepas.

    Valid values:

    • 0 :

      Segera hapus semua set cadangan.

    • 1 :

      Simpan set cadangan terakhir untuk Kata kunci jangka panjang (LTR).

    • 2 :

      Simpan semua set cadangan untuk Kata kunci jangka panjang (LTR).

    2
    PreferredNextBackupTime

    string

    Pengatur waktu saat cadangan dimulai, dalam format HH:mmZ-HH:mmZ (UTC), misalnya 01:00Z-02:00Z. Cadangan dimulai pada suatu titik waktu dalam pengatur waktu ini.

    2024-06-19T19:11Z
    AdvancedBackupDataPolicies

    array<object>

    Daftar kebijakan cadangan.

    object

    PolicyId

    string

    ID kebijakan cadangan.

    xxxxxx
    ActionType

    string

    Tipe aksi.

    xx
    RetentionType

    string

    Tipe Kata kunci retensi set cadangan. Nilai valid:

    • never: Kata kunci jangka panjang (LTR).

    • delay: retensi untuk jumlah hari tetap.

    Valid values:

    • never :

      Kata kunci jangka panjang (LTR).

    • delay :

      Retensi untuk jumlah hari tetap.

    delay
    RetentionPeriod

    integer

    Jumlah hari cadangan disimpan.

    7
    BackupPolicy

    string

    Tipe penjadwalan kebijakan lanjutan. Nilai valid:

    • dayOfWeek: penjadwalan mingguan.

    • dayOfMonth: penjadwalan bulanan.

    • dayOfYear: penjadwalan tahunan.

    • backupInterval: penjadwalan interval tetap (cadangan frekuensi tinggi).

    Valid values:

    • dayOfWeek :

      Penjadwalan mingguan.

    • dayOfMonth :

      Penjadwalan bulanan.

    • dayOfYear :

      Penjadwalan tahunan.

    • backupInterval :

      Penjadwalan interval tetap (cadangan frekuensi tinggi).

    dayOfWeek
    PreferredBackupPeriod

    string

    Siklus cadangan.

    • Jika BackupPolicy=dayOfWeek: 1,2,3,4,5,6,7 menunjukkan Senin hingga Minggu.

    • Jika BackupPolicy=dayOfMonth: 1,3,-1 menunjukkan tanggal 1, 3, dan terakhir setiap bulan.

    • Jika BackupPolicy=dayOfYear: 01-07 menunjukkan 7 Januari.

    • Jika BackupPolicy=backupInterval: 30 menunjukkan cadangan setiap 30 menit.

    1,2,3
    SrcRegion

    string

    Wilayah tempat instans berada.

    cn-beijing
    SrcType

    string

    Tipe sumber kebijakan cadangan.

    • db: cadangan dalam wilayah yang sama.

    • level1: cadangan lintas wilayah.

    Valid values:

    • level1 :

      Cadangan lintas wilayah.

    • db :

      Cadangan dalam wilayah yang sama.

    db
    DestRegion

    string

    Wilayah tujuan kebijakan cadangan.

    cn-beijing
    DestType

    string

    Jenis tujuan kebijakan cadangan.

    • level1: cadangan dalam wilayah yang sama.

    • level2Cross: cadangan lintas wilayah.

    Valid values:

    • level1 :

      Cadangan dalam wilayah yang sama.

    • level2Cross :

      Cadangan lintas wilayah.

    level1
    PreserveOneEachHour

    boolean

    Apakah cadangan jarang per jam diaktifkan.

    • true: Saat frekuensi cadangan berada di level menit, semua snapshot dalam satu jam terakhir disimpan. Untuk snapshot yang berusia lebih dari 1 jam tetapi dalam 24 jam, hanya snapshot pertama setelah setiap jam penuh yang disimpan.

    • false: Cadangan jarang per jam dinonaktifkan. Semua snapshot dalam periode retensi cadangan frekuensi tinggi disimpan.

    False
    AdvancedBackupLogPolicies

    array<object>

    Daftar kebijakan cadangan log.

    object

    EnableLogBackup

    integer

    Apakah cadangan log diaktifkan. Nilai valid:

    • 1: Diaktifkan.

    • 0: Dinonaktifkan.

    Valid values:

    • 0 :

      Dinonaktifkan.

    • 1 :

      Diaktifkan.

    1
    RetentionType

    string

    Tipe Kata kunci retensi cadangan log. Nilai valid:

    • never: Kata kunci jangka panjang (LTR).

    • delay: retensi untuk jumlah hari tetap.

    Valid values:

    • never :

      Kata kunci jangka panjang (LTR).

    • delay :

      Retensi untuk jumlah hari tetap.

    delay
    RetentionPeriod

    string

    Jumlah hari cadangan log disimpan. Parameter ini hanya berlaku saat RetentionType diatur ke delay.

    4
    SrcRegion

    string

    Wilayah tempat instans sumber berada.

    cn-hangzhou
    SrcType

    string

    Tipe sumber kebijakan cadangan log.

    • db: cadangan dalam wilayah yang sama.

    • level1: cadangan lintas wilayah.

    Valid values:

    • level1 :

      Cadangan lintas wilayah.

    • db :

      Cadangan dalam wilayah yang sama.

    et
    DestRegion

    string

    Wilayah tujuan kebijakan cadangan log.

    cn-guangzhou
    DestType

    string

    Jenis tujuan kebijakan cadangan log.

    • level1: cadangan dalam wilayah yang sama.

    • level2Cross: cadangan lintas wilayah.

    Valid values:

    • level1 :

      Cadangan dalam wilayah yang sama.

    • level2Cross :

      Cadangan lintas wilayah.

    RDS
    PolicyId

    string

    ID kebijakan cadangan log. Parameter ini hanya ada untuk kebijakan cadangan log lintas wilayah.

    xxxx

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "111E7B16-0A87-4CBA-B271-F34AD61E099F",
  "DBInstanceId": "dds-bp14bf67a76d****",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "SnapshotBackupType": "Jenis Penyimpanan Standar",
  "BackupRetentionPolicyOnClusterDeletion": 2,
  "PreferredNextBackupTime": "2024-06-19T19:11Z",
  "AdvancedBackupDataPolicies": [
    {
      "PolicyId": "xxxxxx",
      "ActionType": " xx",
      "RetentionType": "delay",
      "RetentionPeriod": 7,
      "BackupPolicy": "dayOfWeek",
      "PreferredBackupPeriod": "1,2,3",
      "SrcRegion": "cn-beijing",
      "SrcType": "db",
      "DestRegion": "cn-beijing",
      "DestType": "level1",
      "PreserveOneEachHour": true
    }
  ],
  "AdvancedBackupLogPolicies": [
    {
      "EnableLogBackup": 1,
      "RetentionType": "delay",
      "RetentionPeriod": "4",
      "SrcRegion": "cn-hangzhou",
      "SrcType": "et",
      "DestRegion": "cn-guangzhou",
      "DestType": "RDS",
      "PolicyId": "xxxx"
    }
  ]
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidPreferredBackupPeriod.Malformed Specified parameter PreferredBackupPeriod is not valid.
    400 InvalidPreferredBackupTime.Malformed Specified parameter PreferredBackupTime is not valid.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.