調用DescribeBackupPolicy介面查看執行個體備份設定。

RDS執行個體將根據使用者佈建的備份設定，定期做備份。

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String 是 DescribeBackupPolicy

系統規定參數，取值：DescribeBackupPolicy。

DBInstanceId String 是 rm-uf6wjk5xxxxxxx

執行個體ID。
BackupPolicyMode String 否 DataBackupPolicy

備份類型，取值：

  • DataBackupPolicy：資料備份；
  • LogBackupPolicy：記錄備份。
AccessKeyId String 否 LTAIfCxxxxxxx

阿里雲頒發給使用者的訪問服務所用的密鑰ID。
CompressType String 否 1

備份壓縮方式，取值：

  • 0：不壓縮；
  • 1：zlib壓縮；
  • 2：並行zlib壓縮；
  • 4：quicklz壓縮，開啟了庫表恢複；
  • 8：MySQL8.0 quicklz壓縮但是還未支援庫表恢複。

返回資料

名稱 類型 樣本值 描述
BackupRetentionPeriod Integer 7

資料備份保留天數。
PreferredBackupTime String 15:00Z-16:00Z

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

PreferredBackupPeriod String Monday,Wednesday,Friday,Sunday

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

  • Monday：周一；
  • Tuesday：周二；
  • Wednesday：周三；
  • Thursday：周四；
  • Friday：周五；
  • Saturday：周六；
  • Sunday：周日。
BackupLog String Enable

記錄備份開關，取值：Enable | Disabled
LogBackupRetentionPeriod Integer 7

記錄備份保留天數。
Duplication String Enable

是否將備份檔案轉儲至OSS，取值：Enable | Disabled
DuplicationContent String DATA&LOG

轉儲資料備份或者記錄備份，取值：

  • DATA：轉儲資料備份；
  • LOG：轉儲記錄備份；
  • DATA&LOG：轉儲資料備份和記錄備份。
说明 當Duplication=Enable時，本參數必填。
DuplicationLocation

備份檔案的儲存位置。
Location

位置資訊。
Bucket String mybucket

轉儲的目標OSS Bucket的名稱。
Endpoint String oss-cn-shanghai.aliyuncs.com

轉儲目的域的名稱。
Sotrage String OSS

備份儲存介質。
EnableBackupLog String 1

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

  • 1：表示開啟；
  • 0：表示關閉。
HighSpaceUsageProtection String Enable

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

  • Disable：不清理；
  • Enable：清理。
LocalLogRetentionHours Integer 0

本地記錄備份保留小時數。
LocalLogRetentionSpace String 30

本地日誌最大空間使用率。
LogBackupFrequency String LogInterval

記錄備份頻率，取值：

  • LogInterval：每30分鐘備份一次；
  • 預設與資料備份周期PreferredBackupPeriod一致。
说明 參數LogBackupFrequency僅適用於SQL Server。
PreferredNextBackupTime String 2018-01-19T15:15Z

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

RequestId String B87E2AB3-B7C9-4394-9160-7F639F732031

請求ID。
CompressType String 1

備份壓縮方式，取值：

  • 0：不壓縮；
  • 1：zlib壓縮；
  • 2：並行zlib壓縮；
  • 4：quicklz壓縮，開啟了庫表恢複；
  • 8：MySQL8.0 quicklz壓縮但是還未支援庫表恢複。

樣本

請求樣本


http(s)://rds.aliyuncs.com/?Action=DescribeBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&<公用請求參數>

正常返回樣本

XML 格式 

<DescribeBackupPolicyResponse>
	  <backupLog>Enable</backupLog>
	  <backupRetentionPeriod>7</backupRetentionPeriod>
	  <logBackupRetentionPeriod>7</logBackupRetentionPeriod>
	  <preferredBackupPeriod>Monday,Wednesday,Friday,Sunday</preferredBackupPeriod>
	  <preferredBackupTime>15:00Z-16:00Z</preferredBackupTime>
	  <preferredNextBackupTime>2018-01-19T15:15Z</preferredNextBackupTime>
	  <requestId>B87E2AB3-B7C9-4394-9160-7F639F732031</requestId></DescribeBackupPolicyResponse>

JSON 格式 

{
	"preferredBackupPeriod":"Monday,Wednesday,Friday,Sunday",
	"requestId":"B87E2AB3-B7C9-4394-9160-7F639F732031",
	"logBackupRetentionPeriod":7,
	"backupRetentionPeriod":7,
	"backupLog":"Enable",
	"preferredNextBackupTime":"2018-01-19T15:15Z",
	"preferredBackupTime":"15:00Z-16:00Z"
}

錯誤碼

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