All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeBackupPolicy

    Document Center

    ApsaraDB for MongoDB:DescribeBackupPolicy

    Last Updated:Jun 10, 2026

    Mengkueri kebijakan cadangan instans 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 replica set

    • sharding: instans kluster sharded.

    sharding
    SrcRegion

    string

    No

    Wilayah tempat instans berada.

    cn-beijing

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The returned data.

    PreferredBackupPeriod

    string

    The backup cycle. Valid values:

    • Monday: Monday.

    • Tuesday: Tuesday.

    • Wednesday: Wednesday.

    • Thursday: Thursday.

    • Friday: Friday.

    • Saturday: Saturday.

    • Sunday: Sunday.

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

    string

    The request ID.

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

    string

    The backup time in the format of HH:mmZ-HH:mmZ (UTC time).

    09:00Z-10:00Z
    BackupRetentionPeriod

    string

    The backup retention period in days.

    30
    PreferredNextBackupTime

    string

    The next regular backup time in the format of yyyy-mm-ddthh:mmz (UTC time).

    2024-06-19T19:11Z
    EnableBackupLog

    integer

    Indicates whether log backup is enabled. Valid values:

    • 0: disabled (default).

    • 1: enabled.

    1
    LogBackupRetentionPeriod

    integer

    The log backup retention period in days. Valid values: 7 to 730.

    7
    SnapshotBackupType

    string

    The snapshot backup type. Valid values:

    • Flash: second-level backup.

    • Standard: regular backup (default).

    Standard
    BackupInterval

    integer

    The high-frequency backup frequency. Valid values:

    • -1: high-frequency backup is disabled.

    • 15: every 15 minutes.

    • 30: every 30 minutes.

    • 60: every 1 hour.

    • 120: every 2 hours.

    • 180: every 3 hours.

    • 240: every 4 hours.

    • 360: every 6 hours.

    • 480: every 8 hours.

    • 720: every 12 hours.

    -1
    HighFrequencyBackupRetention

    string

    The high-frequency backup retention period in days.

    1
    BackupRetentionPolicyOnClusterDeletion

    integer

    The backup retention policy.

    1. 0: All backup sets of the instance are immediately deleted when the instance is released

    2. 1: The instance is automatically backed up when it is released, and the backup set is retained for a long time

    3. 2: The instance is automatically backed up when it is released, and all backup sets of the cluster are retained for a long time

    For more information, see Long-term backup retention

    0
    SrcRegion

    string

    The region where the source instance is located.

    cn-hangzhou
    DestRegion

    string

    The region where the geo-redundancy backup is located.

    cn-shenzhen
    CrossRetentionType

    string

    The geo-redundancy backup retention type.

    • delay: retained for a period of time

    • never: never expires

    delay
    CrossRetentionValue

    integer

    The geo-redundancy backup retention period.

    7
    CrossBackupPeriod

    string

    The geo-redundancy backup retention time.

    1. Monday: Monday.

    2. Tuesday: Tuesday.

    3. Wednesday: Wednesday.

    4. Thursday: Thursday.

    5. Friday: Friday.

    6. Saturday: Saturday.

    7. Sunday: Sunday.

    Catatan

    Required for geo-redundancy backup

    Monday
    EnableCrossLogBackup

    integer

    Indicates whether cross-region log backup is enabled.

    Catatan

    Required for geo-redundancy backup

    • 1: enabled (must be 1 for sharded cluster instances)

    • 0: disabled (must be 0 for replica set instances)

    1
    CrossLogRetentionType

    string

    The geo-redundancy log backup retention type.

    • delay: retained for a period of time

    • never: never expires

    delay
    CrossLogRetentionValue

    integer

    The geo-redundancy log backup retention period.

    7
    PreserveOneEachHour

    boolean

    Indicates whether sparse backup within an hour is enabled.

    • true: When the backup frequency is at the minute level, all snapshots within 1 hour from the current time are retained. For snapshots that are more than 1 hour but within 24 hours from the current time, only the first snapshot after each hour is retained.

    • false: Sparse backup within an hour is disabled: all snapshots within the high-frequency backup retention period are retained.

    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.