全部產品
Search

搜尋本產品

    PolarDB：DescribeBackupPolicy - 查看PolarDB叢集自動備份策略

    文件中心

    PolarDB：DescribeBackupPolicy - 查看PolarDB叢集自動備份策略

    更新時間：May 14, 2026

    查看PolarDB叢集的自動備份策略。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeBackupPolicy

    get

    *dbcluster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBClusterId

    string

    是

    叢集 ID。

    說明

    您可以調用 DescribeDBClusters 介面查看目標地區下所有的叢集資訊，包括叢集 ID。

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

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    PreferredBackupPeriod

    string

    資料備份周期，取值範圍如下：

    • Monday：周一

    • Tuesday：周二

    • Wednesday：周三

    • Thursday：周四

    • Friday：周五

    • Saturday：周六

    • Sunday：周日

    說明

    開啟進階備份後，該參數不建議使用，請使用參數 AdvancedDataPolicies。

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

    string

    一級備份保留周期，取值範圍為 3~14，單位為天。

    說明

    開啟進階備份後，該參數不建議使用，請使用參數 AdvancedDataPolicies。

    7
    RequestId

    string

    請求 ID。

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

    string

    執行自動備份的時間段，格式為HH:mmZ-HH:mmZ（UTC 時間）。

    07:00Z-08:00Z
    BackupRetentionPolicyOnClusterDeletion

    string

    刪除叢集時是否保留備份：

    • ALL：長期保留全部備份。

    • LATEST：長期保留最後一個備份。

    • NONE（預設）：不保留備份組。

    NONE
    PreferredNextBackupTime

    string

    下一次備份的時間，格式為YYYY-MM-DDThh:mmZ（UTC 時間）。

    2020-11-16T07:30Z
    DataLevel2BackupRetentionPeriod

    string

    二級備份保留周期，取值範圍如下：

    • 0：關閉二級備份功能。

    • 30～7300：二級備份保留周期，單位為天。

    • -1：二級備份長期保留。

    說明

      • 建立叢集時，預設取值為 0，即關閉二級備份功能。

      • 開啟進階備份後，該參數不建議使用，請使用參數 AdvancedDataPolicies。

    0
    BackupFrequency

    string

    備份頻率，取值如下：

    • Normal（預設）：常規備份，每天定時備份一次。

    • 2/24H：增強備份，每 2 小時備份一次。

    • 3/24H：增強備份，每 3 小時備份一次。

    • 4/24H：增強備份，每 4 小時備份一次。

    說明

    • 開啟增強備份後，備份完成時間在 24 小時內的備份會全部保留。超過 24 小時的，系統將僅保留每日 00:00 點後完成的第一個備份，其他均被刪除。

    • 開啟增強備份後，備份周期 PreferredBackupPeriod 參數會預設選擇一周內的所有天數（即從周一至周日）。

    Normal
    DataLevel1BackupFrequency

    string

    備份頻率，取值如下：

    • Normal（預設）：常規備份，每天定時備份一次。

    • 2/24H：高頻備份，每 2 小時備份一次。

    • 3/24H：高頻備份，每 3 小時備份一次。

    • 4/24H：高頻備份，每 4 小時備份一次。

    說明

      • PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。

      • 如果您的 PolarDB MySQL 版所在的地區不支援跨地區備份功能，將不支援該參數。跨地區備份支援的地區請參見概述。

      • 開啟進階備份後，該參數不建議使用，請使用參數 AdvancedDataPolicies。

    Normal
    DataLevel1BackupPeriod

    string

    一級備份周期，取值範圍如下：

    • Monday：周一

    • Tuesday：周二

    • Wednesday：周三

    • Thursday：周四

    • Friday：周五

    • Saturday：周六

    • Sunday：周日

    說明

      • 至少需要選擇 2 天，多個值之間用英文逗號（,）隔開。

      • PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。

      • 如果您的 PolarDB MySQL 版所在的地區不支援跨地區備份功能，將不支援該參數。跨地區備份支援的地區請參見概述。

      • 開啟進階備份後，該參數不建議使用，請使用參數 AdvancedDataPolicies。

    Monday,Tuesday
    DataLevel1BackupTime

    string

    執行自動備份的時間段，格式為hh:mmZ-hh:mmZ（UTC 時間），且輸入的數值必須為間隔 1 個小時的整點，如14:00Z-15:00Z。

    說明

    • PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。

    • 如果您的 PolarDB MySQL 版所在的地區不支援跨地區備份功能，將不支援該參數。跨地區備份支援的地區請參見概述。

    15:00Z-16:00Z
    DataLevel2BackupPeriod

    string

    二級備份周期，取值範圍如下：

    • Monday：周一

    • Tuesday：周二

    • Wednesday：周三

    • Thursday：周四

    • Friday：周五

    • Saturday：周六

    • Sunday：周日

    說明

      • 至少需要選擇 2 天，多個值之間用英文逗號（,）隔開。

      • PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。

      • 如果您的 PolarDB MySQL 版所在的地區不支援跨地區備份功能，將不支援該參數。跨地區備份支援的地區請參見概述。

      • 開啟進階備份後，該參數不建議使用，請使用參數 AdvancedDataPolicies。

    Monday,Tuesday
    DataLevel2BackupAnotherRegionRetentionPeriod

    string

    二級備份跨地區備份保留周期。取值範圍如下：

    • 0：關閉二級備份功能。

    • 30～7300：二級備份保留周期，單位為天。

    • -1：二級備份長期保留。

    說明

      • 建立叢集時，預設取值為 0，即關閉二級備份跨地區備份功能。

      • 開啟進階備份後，該參數不建議使用，請使用參數 AdvancedDataPolicies。

    30
    DataLevel2BackupAnotherRegionRegion

    string

    二級備份跨地區備份地區。跨地區備份支援的地區請參見概述。

    說明

    開啟進階備份後，該參數不建議使用，請使用參數 AdvancedDataPolicies。

    cn-hangzhou
    BackupPolicyLevel

    string

    當前備份策略等級。取值範圍如下：

    • Normal：常規備份

    • Advanced：進階備份

    說明

    • PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。

    Normal
    AdvancedPolicyOption

    string

    進階備份策略選項。取值範圍如下：

    • enable：已開啟進階備份

    • disable：未開啟進階備份，可選擇開啟

    • notSupport：不支援進階備份

    說明

    • PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。

    disable
    AdvancedDataPolicies

    object

    AdvancedDataPolicy

    array<object>

    進階備份策略詳情。

    說明

    • PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。

    object

    PolicyId

    string

    備份策略 ID。

    71930ac2e9f15e41615e10627c******

    RetentionType

    string

    備份組保留周期類型，傳回值如下：

    • never：長期保留

    • delay：固定天數保留

    delay
    RetentionValue

    string

    備份保留天數。

    7
    FilterType

    string

    進階策略篩選類型，傳回值如下：

    • crontab：周期調度

    • event：事件調度

    crontab
    FilterKey

    string

    調度類型，傳回值如下：

    • dayOfWeek：按周調度

    • dayOfMonth：按月調度

    • dayOfYear：按年調度

    • backupInterval：固定間隔調度

    說明

    僅當 FilterType 為 crontab 時，返回該參數。

    dayOfWeek
    FilterValue

    string

    備份周期。

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

    string

    備份策略源類型，傳回值如下：

    • db：資料庫叢集

    • level1：一級備份

    • level2：二級備份

    • level2Cross：二級跨地區備份

    level1
    SrcRegion

    string

    備份策略源地區。

    cn-beijing
    DestType

    string

    備份策略目標類型，傳回值如下：

    • level1：一級備份

    • level2：二級備份

    • level2Cross：二級跨地區備份

    level1
    DestRegion

    string

    備份策略目標地區。

    cn-hangzhou
    DumpAction

    string

    一級備份轉二級備份方式，傳回值如下：

    • copy：複製

    copy
    AutoCreated

    boolean

    是否為系統自動產生的備份策略，傳回值如下：

    • true：系統建置原則

    • false：使用者自訂策略

    true
    OnlyPreserveOneEachHour

    boolean

    每小時備份保留原則。取值如下：

    • true：超過 1 小時只保留每小時內最早的備份組。

    • false：保留全部備份組。

    true
    OnlyPreserveOneEachDay

    boolean

    24 小時備份保留原則。

    • true：超過 24 小時僅保留當天第 1 個備份組

    • false：全保留

    true
    BakType

    string

    備份類型，傳回值如下：

    • F：全量備份

    F
    StorageClass

    string

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。

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

    變更歷史

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