描述

查詢數據庫的備份集。備份集的狀態必須是“完成備份”,才能用于恢復。

請求參數

名稱 類型 是否必須 描述
<公共請求參數> - - 參見公共參數
Action String 系統規定參數,取值:DescribeDatabaseBackup。
InstanceId String 實例名。
DBName String 數據庫名。
BackupStatus String 備份集狀態,取值如下:
  • Success:完成備份;
  • Failed:備份失敗。
BackupMode String 備份類型。取值范圍:
  • Automated:常規任務;
  • Manual:臨時任務。
StartTime String 查詢開始時間,格式如:2018-07-15T15:00Z。
EndTime String 查詢結束時間,格式如:2018-07-20T16:00Z,且大于查詢開始時間。
PageSize Integer 每頁記錄數,取值:30、50、100;默認值:30。
PageNumber Integer 頁碼,大于0且不超過Integer的最大值。默認值:1。

返回參數

名稱 類型 描述
<公共返回參數> String 參見公共返回參數
InstanceId String 實例名。
DBName String 數據庫名。
BackupTotalSize Long 備份總大小。
TotalRecordCount String 總記錄數。
PageNumber String 頁碼。
PageRecordCount String 本頁記錄數。
BackupItems List<Backup> 由備份集組成的數組。
表 1. Backup參數
名稱 類型 描述
BackupId String 備份ID。
BackupStatus String 備份狀態:
  • Progress :備份中;
  • Success:完成備份;
  • Failed:備份失敗。
BackupStartTime String 本次備份開始時間,格式:"YYYY-MM-DDTHH:mm:ssZ",如2018-07-15T03:29:00Z。
BackupEndTime String 本次備份結束時間,格式:"YYYY-MM-DDTHH:mm:ssZ",如2018-07-20T03:29:00Z。
BackupType String 備份類型:
  • FullBackup:全量備份;
  • IncrementalBackup:增量備份。
BackupMode String 備份類型,取值如下:
  • Automated:常規任務;
  • Manual:臨時任務。
BackupMethod String 備份方式:
  • Logical:邏輯備份;
  • Physical:物理備份;
  • Snapshot:快照備份
  • 默認值為Snapshot。
BackupDownloadURL String 備份下載地址。
BackupSize Long 備份大小。
BackupNodeNumber Integer 備份節點數。
BackupNodeClass String 備份規格。

請求示例

https://petadata.aliyuncs.com/?Action=DescribeDatabaseBackup
&InstanceId=pd-xxxxxxxxxxxxxx
&DBName=testdb
&StartTime=2018-08-01T09:58:53Z
&EndTime=2018-08-08T09:58:53Z
&<公共請求參數>

返回示例

XML格式

<DescribeDatabaseBackupResponse>  
	<TotalRecordCount>2</TotalRecordCount>
	<PageNumber>1</PageNumber>
	<BackupItems>
		<Backup>
			<BackupNodeNumber>2</BackupNodeNumber>
			<BackupEndTime>2018-08-08T10:03Z</BackupEndTime>
			<BackupMode>Manual</BackupMode>
			<BackupSize>3</BackupSize>
			<BackupStatus>Success</BackupStatus>
			<BackupNodeClass>petadata.s2.xlarge</BackupNodeClass>
			<BackupStartTime>2018-08-08T09:58Z</BackupStartTime>
			<BackupId>15466</BackupId>
		</Backup>
		<Backup>
			<BackupNodeNumber>2</BackupNodeNumber>
			<BackupEndTime>2018-08-08T09:10Z</BackupEndTime>
			<BackupMode>Manual</BackupMode>
			<BackupSize>3</BackupSize>
			<BackupStatus>Success</BackupStatus>
			<BackupNodeClass>petadata.s2.xlarge</BackupNodeClass>
			<BackupStartTime>2018-08-08T09:05Z</BackupStartTime>
			<BackupId>15463</BackupId>
		</Backup>
	</BackupItems>
	<InstanceId>pd-xxxxxxxxxxxxxx</InstanceId>
	<RequestId>4FEBF191-CDAB-4223-AF0D-38FC06261893</RequestId>
	<BackupTotalSize>0</BackupTotalSize>
	<DBName>testdb</DBName>
	<PageRecordCount>30</PageRecordCount>
</DescribeDatabaseBackupResponse>

JSON格式

{
    "TotalRecordCount":2,
    "PageNumber":1,
    "BackupItems":{
        "Backup":[
            {
                "BackupNodeNumber":2,
                "BackupEndTime":"2018-08-08T10:03Z",
                "BackupMode":"Manual",
                "BackupSize":3,
                "BackupStatus":"Success",
                "BackupNodeClass":"petadata.s2.xlarge",
                "BackupStartTime":"2018-08-08T09:58Z",
                "BackupId":15466
            },
            {
                "BackupNodeNumber":2,
                "BackupEndTime":"2018-08-08T09:10Z",
                "BackupMode":"Manual",
                "BackupSize":3,
                "BackupStatus":"Success",
                "BackupNodeClass":"petadata.s2.xlarge",
                "BackupStartTime":"2018-08-08T09:05Z",
                "BackupId":15463
            }
        ]
    },
    "InstanceId":"pd-xxxxxxxxxxxxxx",
    "RequestId":"4FEBF191-CDAB-4223-AF0D-38FC06261893",
    "BackupTotalSize":0,
    "DBName":"testdb",
    "PageRecordCount":30
}