全部產品
Search

搜尋本產品

    ApsaraDB RDS：DescribeBackupPolicy

    文件中心

    ApsaraDB RDS：DescribeBackupPolicy

    更新時間：Jun 26, 2026

    該介面用於查詢 RDS 執行個體的備份設定。

    介面說明

    適用引擎

    • RDS MySQL

    • RDS PostgreSQL

    • RDS SQL Server

    • RDS MariaDB。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    rds:DescribeBackupPolicy

    get

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    • rds:ResourceTag
    • rds:ResourceTag
    • rds:ResourceTag
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    是

    執行個體 ID。可呼叫 DescribeDBInstances 取得。

    rm-uf6wjk5****
    BackupPolicyMode

    string

    否

    備份類型，取值：

    • DataBackupPolicy：資料備份

    • LogBackupPolicy：日誌備份。

    DataBackupPolicy
    CompressType

    string

    否

    備份壓縮方式，取值：

    • 0：不壓縮

    • 1：zlib 壓縮

    • 2：並行 zlib 壓縮

    • 4：quicklz 壓縮，開啟了庫表恢復

    • 8：quicklz 壓縮但還未支援庫表恢復。

    1
    ReleasedKeepPolicy

    string

    否

    MySQL 已刪除執行個體的歸檔備份保留策略。取值：

    • None：不保留

    • Lastest：保留最後一個

    • All：全部保留。

    Lastest

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數詳情。

    ArchiveBackupKeepCount

    string

    MySQL 執行個體歸檔備份的保留個數。

    1
    ArchiveBackupKeepPolicy

    string

    MySQL 執行個體歸檔備份的保留週期。

    ByMonth
    ArchiveBackupRetentionPeriod

    string

    MySQL 執行個體歸檔備份的保留天數。

    365
    BackupInterval

    string

    備份間隔，單位：分鐘。

    • 對於 MySQL 執行個體：指快照備份頻率（非快照備份週期）。

    • 對於 SQL Server 執行個體：指日誌備份頻率。

    30
    BackupLog

    string

    是否已開啟日誌備份。返回值：

    • Enable：是

    • Disabled：否

    對於 SQL Server 執行個體：

    • 僅執行個體日誌備份頻率為每 5 分鐘時才返回 Enable；

    • 日誌備份頻率為每 30 分鐘或與資料備份一致時，本參數返回 Disabled。請以 BackupInterval 返回值為準。

    Enable
    BackupMethod

    string

    SQL Server 雲端硬碟版執行個體的備份方式。返回值：

    • Physical：物理備份

    • Snapshot：快照備份。

    Physical
    BackupPriority

    integer

    SQL Server 企業叢集版執行個體備庫備份的設定。返回值：

    • 1：優先備庫

    • 2：強制主庫

    說明

    僅當 SupportModifyBackupPriority 為 True 時返回該參數。

    2
    BackupRetentionPeriod

    integer

    資料備份保留天數。

    7
    Category

    string

    MySQL 和 PostgreSQL 執行個體是否已開啟秒級備份。返回值：

    • Flash：開啟

    • Standard：關閉

    說明

    僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。

    Standard
    CompressType

    string

    備份壓縮方式。返回值：

    • 0：不壓縮

    • 1：zlib 壓縮

    • 2：並行 zlib 壓縮

    • 4：quicklz 壓縮，開啟了庫表恢復

    • 8：quicklz 壓縮但還未支援庫表恢復。

    1
    EnableBackupLog

    string

    是否開啟了日誌備份。返回值：

    • 1：開啟

    • 0：關閉

    對於 SQL Server 執行個體：

    • 僅執行個體日誌備份頻率為每 5 分鐘時才返回 1。

    • 日誌備份頻率為每 30 分鐘或與資料備份一致時，本參數返回 0。請以 BackupInterval 返回值為準。

    1
    EnableIncrementDataBackup

    boolean

    SQL Server 執行個體是否已開啟增量備份。返回值：

    • True：是

    • False：否。

    True
    IncBackupInterval

    integer

    EnablePitrProtection

    boolean

    MySQL 執行個體是否已開啟 PITR 任意時間點恢復（原日誌備份的升級版）。返回值：

    • True：是

    • False：否

    說明

    功能詳情，請參見設定任意時間點恢復策略。

    True
    HighSpaceUsageProtection

    string

    MySQL 執行個體使用空間大於 80%，或者剩餘空間小於 5 GB 時，是否強制清理 Binlog。返回值：

    • Disable：不清理

    • Enable：清理。

    Enable
    LocalLogRetentionHours

    integer

    MySQL 執行個體本地日誌備份保留小時數。

    0
    LocalLogRetentionSpace

    string

    MySQL 執行個體本地日誌最大空間使用率。

    30
    LogBackupFrequency

    string

    SQL Server 執行個體的日誌備份頻率。返回值：

    • LogInterval：每 30 分鐘備份一次；

    • 預設與資料備份週期 PreferredBackupPeriod 一致。

    LogInterval
    LogBackupLocalRetentionNumber

    integer

    MySQL 執行個體本地 Binlog 保留個數。

    60
    LogBackupRetentionPeriod

    integer

    日誌備份保留天數。

    7
    PitrRetentionPeriod

    integer

    MySQL 執行個體的可任意時間點恢復天數。

    7
    PreferredBackupPeriod

    string

    資料備份週期，多個取值用英文逗號（,）隔開。返回值：

    • Monday：週一

    • Tuesday：週二

    • Wednesday：週三

    • Thursday：週四

    • Friday：週五

    • Saturday：週六

    • Sunday：週日。

    Monday,Wednesday,Friday,Sunday
    PreferredBackupTime

    string

    資料備份時間，格式：HH:mmZ-HH:mmZ（UTC 時間）。

    15:00Z-16:00Z
    PreferredNextBackupTime

    string

    下次備份時間。格式：yyyy-MM-ddTHH:mmZ（UTC 時間）。

    2018-01-19T15:15Z
    ReleasedKeepPolicy

    string

    MySQL 已刪除執行個體的歸檔備份保留策略。返回值：

    • None：不保留

    • Lastest：保留最後一個

    • All：全部保留。

    None
    RequestId

    string

    請求 ID。

    B87E2AB3-B7C9-4394-9160-7F639F732031
    SupportModifyBackupPriority

    boolean

    SQL Server 執行個體是否支援修改備庫備份選項。返回值：

    • True：是

    • False：否。

    False
    SupportReleasedKeep

    integer

    備用參數。

    0
    SupportVolumeShadowCopy

    integer

    SQL Server 執行個體是否支援快照備份。返回值：

    • 1：是

    • 0：否。

    1
    SupportsHighFrequencyBackup

    integer

    SQL Server 執行個體是否支援 5 分鐘日誌備份功能。返回值：

    • 0：不支援

    • 1：支援。

    0
    AdvancedDataPolicies

    object

    AdvancedDataPolicy

    array<object>

    object

    StrategyId

    string

    ActionType

    string

    OnlyPreserveOneEachHour

    boolean

    RetentionValue

    integer

    BakType

    string

    FilterKey

    string

    FilterValue

    string

    DestType

    string

    FilterType

    string

    SrcRegion

    string

    OnlyPreserveOneEachDay

    boolean

    SrcType

    string

    DestRegion

    string

    RetentionType

    string

    AdvancedLogPolicies

    object

    AdvancedLogPolicy

    array<object>

    object

    StrategyId

    string

    ActionType

    string

    LogRetentionType

    string

    DestType

    string

    EnableLogBackup

    integer

    SrcType

    string

    SrcRegion

    string

    LogRetentionValue

    integer

    DestRegion

    string

    FilterKey

    string

    FilterValue

    string

    AdvancedBackupPolicyEnabled

    boolean

    樣本

    正常返回樣本

    JSON格式

    {
  "ArchiveBackupKeepCount": "1",
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "BackupLog": "Enable",
  "BackupMethod": "Physical",
  "BackupPriority": 2,
  "BackupRetentionPeriod": 7,
  "Category": "Standard",
  "CompressType": "1",
  "EnableBackupLog": "1",
  "EnableIncrementDataBackup": true,
  "IncBackupInterval": 0,
  "EnablePitrProtection": true,
  "HighSpaceUsageProtection": "Enable",
  "LocalLogRetentionHours": 0,
  "LocalLogRetentionSpace": "30",
  "LogBackupFrequency": "LogInterval",
  "LogBackupLocalRetentionNumber": 60,
  "LogBackupRetentionPeriod": 7,
  "PitrRetentionPeriod": 7,
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "ReleasedKeepPolicy": "None",
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "SupportModifyBackupPriority": true,
  "SupportReleasedKeep": 0,
  "SupportVolumeShadowCopy": 1,
  "SupportsHighFrequencyBackup": 0,
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "OnlyPreserveOneEachHour": false,
        "RetentionValue": 0,
        "BakType": "",
        "FilterKey": "",
        "FilterValue": "",
        "DestType": "",
        "FilterType": "",
        "SrcRegion": "",
        "OnlyPreserveOneEachDay": false,
        "SrcType": "",
        "DestRegion": "",
        "RetentionType": ""
      }
    ]
  },
  "AdvancedLogPolicies": {
    "AdvancedLogPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "LogRetentionType": "",
        "DestType": "",
        "EnableLogBackup": 0,
        "SrcType": "",
        "SrcRegion": "",
        "LogRetentionValue": 0,
        "DestRegion": "",
        "FilterKey": "",
        "FilterValue": ""
      }
    ]
  },
  "AdvancedBackupPolicyEnabled": false
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 IO.Exception IO exception, retry later.
    400 InternalFailure Internal failure, retry later.
    400 InvalidParameter.OwnerAccount The specified parameter OwnerAccount is not valid.
    400 InvalidEngine.Malformed Specified engine is not valid.
    400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently.
    400 Price.PricingPlanResultNotFound Pricing plan price result not found.
    400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
    400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase.
    400 CommodityServiceCalling.Exception Failed to call commodity service.
    400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again.
    400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
    400 Price.CommoditySys Commodity system call exception.
    400 Pay.InsufficientBalance Insufficient available balance.
    400 Order.PeriodInvalid There is a problem with the period you selected, please choose again.
    400 pay.noCreditCard Account not bound to credit card.
    400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method.
    400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation.
    400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details.
    400 Api.NotSupport Specified api is not supported.
    400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance.
    400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records.
    400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type
    400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
    400 KmsApiError User secret key invalid.
    400 System.SaleValidateFailed Sales expression validation system error.
    400 Abs.InvalidAccount.NotFound account is not found.
    400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s.
    400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled.
    400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled.
    400 IncorrectTargetClasscode The current instance type does not support this operation.
    400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS.
    400 RequiredParam.NotFound Required input param is not found.
    400 Parameters.Invalid Parameter error, please check the parameters.
    400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
    400 InvalideStatus.Format The instance status does not support this operation.
    400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid.
    400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation.
    400 Pay.NoCreditCard No credit cards.
    400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation.
    400 MirrorInsExists Specified DB instance mirror ins already existed.
    400 UnsupportedClassCode The specified DB instance class stops selling.
    400 InvalidBackupSet The specified database does not exist in the backup set.
    400 OrdTCommodityQueryError Failed to query for product.
    400 ProductInstanceReleased The instance has been released. Please check before placing the order.
    400 RegionEndTimeDissolvedIndia The region is no longer supported.
    500 ExternalFailure The request processing has failed due to external service failure.
    500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel.
    500 InvokeProxyFailure The request processing has failed due to service failure of rds api.
    403 IncorrectDBInstanceState Current DB instance state does not support this operation.
    403 OrderStatus.UnPaid The specified db instance has unpaid order.
    403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount.
    403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd.
    403 InvalidUserOperatorPermission The user permission does not support this operation.
    403 InvalidVswitchId Specified conn vswitch id is not valid.
    403 IncorrectMinorVersion Current engine minor version does not support operations.
    403 OperationDenied.ZoneResource There is no available zone for inventory.
    403 NotInFlowController Sorry,no permission.
    403 InvalidKmsKey Kms key is disabled.
    403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation.
    404 InvalidDBInstance.NotFound Specified instance does not exist or not support.
    404 InvalidDBInstanceName.NotFound Invalid DBInstanceId NotFound.
    404 InvalidClusterKms The current instance does not authorized to access the Key Management Service.
    404 Request.NotFound The requested resource is not available.
    404 HostInfo.NotFound The specified host info is not found.

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

    變更歷史

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