全部產品
Search

搜尋本產品

    ApsaraDB for MongoDB：DescribeBackupPolicy

    文件中心

    ApsaraDB for MongoDB：DescribeBackupPolicy

    更新時間：Jun 09, 2026

    查詢MongoDB執行個體的備份策略。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dds:DescribeBackupPolicy

    get

    *dbinstance

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    是

    執行個體 ID。

    dds-bp16cb162771****
    InstanceType

    string

    否

    執行個體類型。

    • replicate: 複本集執行個體

    • sharding: 分區叢集執行個體

    sharding
    SrcRegion

    string

    否

    執行個體所在地區。

    cn-beijing

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    傳回資料。

    PreferredBackupPeriod

    string

    備份週期，取值說明：

    • Monday：星期一。

    • Tuesday：星期二。

    • Wednesday：星期三。

    • Thursday：星期四。

    • Friday：星期五。

    • Saturday：星期六。

    • Sunday：星期日。

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

    string

    請求 ID。

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

    string

    備份時間，格式為HH:mmZ-HH:mmZ（UTC 時間）。

    09:00Z-10:00Z
    BackupRetentionPeriod

    string

    備份保留天數。

    30
    PreferredNextBackupTime

    string

    下次常規備份時間，格式為yyyy-mm-ddthh:mmz（utc 時間）。

    2024-06-19T19:11Z
    EnableBackupLog

    integer

    是否開啟記錄備份，取值說明：

    • 0：關閉（預設值）。

    • 1：開啟。

    1
    LogBackupRetentionPeriod

    integer

    記錄備份保留天數，取值範圍：7~730。

    7
    SnapshotBackupType

    string

    快照備份類型，取值說明：

    • Flash：秒級備份。

    • Standard：常規備份（預設值）。

    Standard
    BackupInterval

    integer

    高頻備份頻率，取值說明：

    • -1：不開啟高頻備份。

    • 15：每 15 分鐘。

    • 30：每 30 分鐘。

    • 60：每 1 小時。

    • 120：每 2 小時。

    • 180：每 3 小時。

    • 240：每 4 小時。

    • 360：每 6 小時。

    • 480：每 8 小時。

    • 720：每 12 小時。

    -1
    HighFrequencyBackupRetention

    string

    高頻備份保留天數，單位為天。

    1
    BackupRetentionPolicyOnClusterDeletion

    integer

    備份保留策略。

    1. 0：執行個體釋放時立即刪除該執行個體的所有備份集

    2. 1：執行個體釋放時會自動備份，長期保留該備份集

    3. 2：執行個體釋放時會自動備份，並長期保留該叢集的所有備份集

    詳細資訊請參見：長期保留備份

    0
    SrcRegion

    string

    源執行個體所在地區。

    cn-hangzhou
    DestRegion

    string

    異地備份所在地區。

    cn-shenzhen
    CrossRetentionType

    string

    異地備份保留類型。

    • delay: 保留一段時間

    • never: 不過期

    delay
    CrossRetentionValue

    integer

    異地備份保留時長。

    7
    CrossBackupPeriod

    string

    異地備份的保留時間。

    1. Monday：週一。

    2. Tuesday：週二。

    3. Wednesday：週三。

    4. Thursday：週四。

    5. Friday：週五。

    6. Saturday：週六。

    7. Sunday：週日。

    說明

    異地備份必填

    Monday
    EnableCrossLogBackup

    integer

    是否開啟跨地區記錄備份 。

    說明

    異地備份必填

    • 1： 開啟 (分區叢集必須為 1)

    • 0： 關閉 (複本執行個體必須為 0)

    1
    CrossLogRetentionType

    string

    異地記錄備份保留類型。

    • delay: 保留一段時間

    • never: 不過期

    delay
    CrossLogRetentionValue

    integer

    異地記錄備份保留時長。

    7
    PreserveOneEachHour

    boolean

    是否開啟小時內稀疏備份。

    • true：當備份頻率為分鐘層級時，距離目前時間 1 小時內的快照全部保留。距離目前時間超過 1 小時且在 24 小時內的快照，僅保留整點後的第一個快照。

    • false：關閉小時內稀疏備份：高頻備份保留天數內的快照全部保留。

    false

    樣本

    正常返回樣本

    JSON格式

    {
  "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": true
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。