All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeBackupPolicy

    Document Center

    ApsaraDB for MongoDB:DescribeBackupPolicy

    Last Updated:Dec 18, 2025

    Mengambil kebijakan cadangan dari instance MongoDB.

    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:DescribeBackupPolicy

    get

    *dbinstance

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceId

    string

    Yes

    ID instans.

    dds-bp16cb162771****
    InstanceType

    string

    No

    Tipe instans.

    • replicate: Instans set replika

    • sharding: Instansi kluster sharded

    sharding
    SrcRegion

    string

    No

    Wilayah tempat instans berada.

    cn-beijing

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Data yang dikembalikan.

    PreferredBackupPeriod

    string

    Siklus cadangan. Nilai yang valid:

    • Monday: Senin.

    • Tuesday: Selasa.

    • Wednesday: Rabu.

    • Thursday: Kamis.

    • Friday: Jumat.

    • Saturday: Sabtu.

    • Sunday: Minggu.

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

    string

    ID permintaan.

    5A9464CA-F7DC-5434-90B1-DF7F197C****
    PreferredBackupTime

    string

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

    09:00Z-10:00Z
    BackupRetentionPeriod

    string

    Periode retensi cadangan dalam hari.

    30
    PreferredNextBackupTime

    string

    Waktu cadangan reguler berikutnya dalam format yyyy-mm-ddthh:mmz (waktu UTC).

    2024-06-19T19:11Z
    EnableBackupLog

    integer

    Menunjukkan apakah cadangan log diaktifkan. Nilai yang valid:

    • 0: dinonaktifkan (default).

    • 1: diaktifkan.

    1
    LogBackupRetentionPeriod

    integer

    Periode retensi cadangan log dalam hari. Nilai yang valid: 7 hingga 730.

    7
    SnapshotBackupType

    string

    Tipe cadangan snapshot. Nilai yang valid:

    • Flash: cadangan tingkat detik.

    • Standard: cadangan reguler (default).

    Standard
    BackupInterval

    integer

    Frekuensi cadangan frekuensi tinggi. Nilai yang valid:

    • -1: cadangan frekuensi tinggi dinonaktifkan.

    • 15: setiap 15 menit.

    • 30: setiap 30 menit.

    • 60: setiap 1 jam.

    • 120: setiap 2 jam.

    • 180: setiap 3 jam.

    • 240: setiap 4 jam.

    • 360: setiap 6 jam.

    • 480: setiap 8 jam.

    • 720: setiap 12 jam.

    -1
    HighFrequencyBackupRetention

    string

    Periode retensi cadangan frekuensi tinggi dalam hari.

    1
    BackupRetentionPolicyOnClusterDeletion

    integer

    Kebijakan retensi cadangan.

    1. 0: Semua set cadangan instans langsung dihapus saat instans dirilis

    2. 1: Instans secara otomatis dibackup saat dirilis, dan set cadangan disimpan untuk jangka panjang

    3. 2: Instans secara otomatis dibackup saat dirilis, dan semua set cadangan kluster disimpan untuk jangka panjang

    Untuk informasi selengkapnya, lihat Long-term backup retention

    0
    SrcRegion

    string

    Wilayah tempat instans sumber berada.

    cn-hangzhou
    DestRegion

    string

    Wilayah tempat cadangan geo-redundansi berada.

    cn-shenzhen
    CrossRetentionType

    string

    Tipe retensi cadangan geo-redundansi.

    • delay: disimpan selama periode tertentu

    • never: tidak pernah kedaluwarsa

    delay
    CrossRetentionValue

    integer

    Periode retensi cadangan geo-redundansi.

    7
    CrossBackupPeriod

    string

    Waktu retensi cadangan geo-redundansi.

    1. Monday: Senin.

    2. Tuesday: Selasa.

    3. Wednesday: Rabu.

    4. Thursday: Kamis.

    5. Friday: Jumat.

    6. Saturday: Sabtu.

    7. Sunday: Minggu.

    Catatan

    Diperlukan untuk cadangan geo-redundansi

    Monday
    EnableCrossLogBackup

    integer

    Menunjukkan apakah cadangan log cross-region diaktifkan.

    Catatan

    Diperlukan untuk cadangan geo-redundansi

    • 1: diaktifkan (harus 1 untuk instansi kluster sharded)

    • 0: dinonaktifkan (harus 0 untuk instans set replika)

    1
    CrossLogRetentionType

    string

    Tipe retensi cadangan log geo-redundansi.

    • delay: disimpan selama periode tertentu

    • never: tidak pernah kedaluwarsa

    delay
    CrossLogRetentionValue

    integer

    Periode retensi cadangan log geo-redundansi.

    7
    PreserveOneEachHour

    boolean

    Menunjukkan apakah cadangan jarang dalam satu jam diaktifkan.

    • true: Saat frekuensi cadangan berada pada tingkat menit, semua snapshot dalam rentang 1 jam dari waktu saat ini disimpan. Untuk snapshot yang lebih dari 1 jam tetapi dalam rentang 24 jam dari waktu saat ini, hanya snapshot pertama setelah setiap jam yang disimpan.

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

    false

    Contoh

    Respons sukses

    JSONformat

    {
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "RequestId": "5A9464CA-F7DC-5434-90B1-DF7F197C****",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "BackupRetentionPeriod": "30",
  "PreferredNextBackupTime": "2024-06-19T19:11Z",
  "EnableBackupLog": 1,
  "LogBackupRetentionPeriod": 7,
  "SnapshotBackupType": "Standard",
  "BackupInterval": -1,
  "HighFrequencyBackupRetention": "1",
  "BackupRetentionPolicyOnClusterDeletion": 0,
  "SrcRegion": "cn-hangzhou",
  "DestRegion": "cn-shenzhen",
  "CrossRetentionType": "delay",
  "CrossRetentionValue": 7,
  "CrossBackupPeriod": "Monday",
  "EnableCrossLogBackup": 1,
  "CrossLogRetentionType": "delay",
  "CrossLogRetentionValue": 7,
  "PreserveOneEachHour": false
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.