DescribeAdvancedBackupPolicy - ApsaraDB for MongoDB

查詢進階備份策略。

介面說明

查詢進階備份策略，僅支援雲端硬碟副本集與雲端硬碟分片叢集執行個體。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。	dds-bp18b0934e70****

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	111E7B16-0A87-4CBA-B271-F34AD61E099F
DBInstanceId	string	執行個體 ID。	dds-bp14bf67a76d****
PreferredBackupTime	string	備份時間，格式為HH:mmZ-HH:mmZ（UTC 時間）。	09:00Z-10:00Z
SnapshotBackupType	string	快照備份類型，取值說明： Flash：秒級備份。 Standard：常規備份。	Standard
BackupRetentionPolicyOnClusterDeletion	integer	備份保留策略。 0：執行個體釋放時立即刪除該執行個體的所有備份組 1：執行個體釋放時會長期保留最後一個備份組 2：執行個體釋放時會長期保留所有備份組	2
PreferredNextBackupTime	string	開始備份的時間範圍，格式為 `HH:mmZ-HH:mmZ`（UTC 時間），如 01:00Z-02:00Z。系統會選擇該時間段內的時間開始備份。	2024-06-19T19:11Z
AdvancedBackupDataPolicies	array<object>	備份策略清單。
	object
PolicyId	string	備份策略 ID。	xxxxxx
ActionType	string	處置動作。	xx
RetentionType	string	備份組保留週期類型，傳回值如下： never：長期保留 delay：固定天數保留	delay
RetentionPeriod	integer	備份保留天數。	7
BackupPolicy	string	進階策略排程類型，取值如下： dayOfWeek：按週排程 dayOfMonth：按月排程 dayOfYear：按年排程 backupInterval：固定間隔排程（高頻備份）	dayOfWeek
PreferredBackupPeriod	string	備份週期。當 BackupPolicy=dayOfWeek：1,2,3,4,5,6,7 表示週一到週日。當 BackupPolicy=dayOfMonth：1,3,-1 表示每月 1、3 和最後一天。當 BackupPolicy=dayOfYear：01-07 表示 1 月 7 日。當 BackupPolicy=backupInterval：30 表示每 30 分鐘備份一次。	1,2,3
SrcRegion	string	執行個體所在地域。	cn-beijing
SrcType	string	備份策略來源類型。 db：同地域備份 level1：跨地域備份	db
DestRegion	string	備份策略目標地域。	cn-beijing
DestType	string	備份策略目標類型。 level1：同地域備份 level2Cross：跨地域備份	level1
PreserveOneEachHour	boolean	是否啟用小時內稀疏備份。 true：當備份頻率為分鐘級時，距離目前時間 1 小時內的快照全部保留。距離目前時間超過 1 小時且在 24 小時內的快照，僅保留整點後的第一個快照。 false：關閉小時內稀疏備份：高頻備份保留天數內的快照全部保留。	False
AdvancedBackupLogPolicies	array<object>	日誌備份策略清單。
	object
EnableLogBackup	integer	是否啟用日誌備份，傳回值如下： 1：已啟用 0：未啟用	1
RetentionType	string	日誌備份保留週期類型，傳回值如下： never：長期保留 delay：固定天數保留	delay
RetentionPeriod	string	日誌備份保留天數，當 RetentionType 為 delay 時生效。	4
SrcRegion	string	來源執行個體所在區域。	cn-hangzhou
SrcType	string	日誌備份策略來源類型。 db：同地域備份 level1：跨地域備份	et
DestRegion	string	日誌備份策略目標地域。	cn-guangzhou
DestType	string	日誌備份策略目標類型。 level1：同地域備份 level2Cross：跨地域備份	RDS
PolicyId	string	日誌備份策略 ID，僅存在於異地日誌備份策略。	xxxx

樣本

正常返回樣本

JSON格式

{
  "RequestId": "111E7B16-0A87-4CBA-B271-F34AD61E099F",
  "DBInstanceId": "dds-bp14bf67a76d****",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "SnapshotBackupType": "Standard",
  "BackupRetentionPolicyOnClusterDeletion": 2,
  "PreferredNextBackupTime": "2024-06-19T19:11Z",
  "AdvancedBackupDataPolicies": [
    {
      "PolicyId": "xxxxxx",
      "ActionType": " xx",
      "RetentionType": "delay",
      "RetentionPeriod": 7,
      "BackupPolicy": "dayOfWeek",
      "PreferredBackupPeriod": "1,2,3",
      "SrcRegion": "cn-beijing",
      "SrcType": "db",
      "DestRegion": "cn-beijing",
      "DestType": "level1",
      "PreserveOneEachHour": true
    }
  ],
  "AdvancedBackupLogPolicies": [
    {
      "EnableLogBackup": 1,
      "RetentionType": "delay",
      "RetentionPeriod": "4",
      "SrcRegion": "cn-hangzhou",
      "SrcType": "et",
      "DestRegion": "cn-guangzhou",
      "DestType": "RDS",
      "PolicyId": "xxxx"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidPreferredBackupPeriod.Malformed	Specified parameter PreferredBackupPeriod is not valid.
400	InvalidPreferredBackupTime.Malformed	Specified parameter PreferredBackupTime is not valid.

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

變更歷史

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