You can call this operation to view the list of backup sets.

Note Backups can be restored only when the BackupStatus parameter is set to Success.

Debugging

You can use OpenAPI Explorer to perform debugging. OpenAPI Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required? Example Description
Action String Yes DescribeBackups

The operation that you want to perform. Set this parameter to DescribeBackups.

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

BackupId String No 327329803

The ID of the backup set.

BackupStatus String No Success

The status of the backup set. Valid values:

  • Success
  • Failed
BackupMode String No Automated

The backup mode. Valid values:

  • Automated
  • Manual
StartTime String No 2011-06-01T16:00Z

The start time of the query. Format: yyyy-MM-ddTHH:mm:ssZ.

EndTime String No 2011-06-15T16:00Z

The end time of the query. It must be later than the start time. Format: yyyy-MM-ddTHH:mm:ssZ.

PageSize Integer No 30

The number of records on each page. Valid values:

  • 30
  • 50
  • 100

Default value: 30.

PageNumber Integer No 1

The page number. It must be greater than 0 and cannot exceed the maximum value of the given Integer.

Default value: 1.

Response parameters

Parameter Type Example Description
TotalRecordCount String 100

The total number of records.

PageNumber String 1

The page number.

PageRecordCount String 30

The number of backup sets on the current page.

Items N/A N/A

The list of backup sets.

BackupId String 321020562

The ID of the backup set.

DBInstanceId String rm-uf6wjk5xxxxxxx

The ID of the instance.

HostInstanceID String 5882781

The ID of the instance that generates a backup set. You can use this parameter to indicate whether the master or slave instance generates the backup set.

BackupStatus String Success

The status of the backup set.

BackupStartTime String 2019-02-03T12:20:00Z

The start time of the current backup. Format: yyyy-MM-ddTHH:mm:ssZ.

BackupEndTime String 2019-02-13T12:20:00Z

The end time of the current backup. Format: yyyy-MM-ddTHH:mm:ssZ.

BackupType String FullBackup

The backup type. Valid values:

  • FullBackup
  • IncrementalBackup
BackupMode String Automated

The backup mode. Valid values:

  • Automated
  • Manual
BackupMethod String Physical

The backup method. Valid values:

  • Logical
  • Physical
BackupDownloadURL String http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx

The download link for the public network access. If the download is unavailable, this parameter is a null string.

BackupIntranetDownloadURL String http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx

The download link for the private network access. If the download is unavailable, this parameter is a null string.

BackupSize Long 2,167,808

The size of the backup file. Unit: Byte.

StoreStatus String Disabled

Indicates whether the data backup can be deleted. Valid values:

  • Enabled
  • Disabled
MetaStatus String OK

The status of the backup set used for restoring database tables. Valid values:

  • OK: The backup set is normal.
  • LARGE: The backup set contains a large number of tables and therefore cannot be used to restore database tables.
  • EMPTY: The backup set fails the backup.
Note A null string indicates that the backup set used for restoring database tables has not been activated.
RequestId String 1A6D328C-84B8-40DC-BF49-6C73984D7494

The ID of the request.

Examples

Sample requests


http(s)://rds.aliyuncs.com/? Action=DescribeBackups
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Successful response examples

XML format 

<DescribeBackupsResponse>
	  <Items>
		    <Backup>
			      <StoreStatus>Disabled</StoreStatus>
			      <HostInstanceID>5882781</HostInstanceID>
			      <BackupLocation>OSS</BackupLocation>
			      <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins10430291/hins5882781_data_20190213201955.tar.gz?OSSAccessKeyId=xxxxxxxx&amp;Expires=1231230&amp;Signature=zIBwxxxxxxx5ga3p%2BVxxxxxxxx%3D</BackupIntranetDownloadURL>
			      <BackupType>FullBackup</BackupType>
			      <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
			      <BackupEndTime>2019-02-13T12:22:53Z</BackupEndTime>
			      <BackupMethod>Physical</BackupMethod>
			      <BackupId>321020562</BackupId>
			      <BackupStartTime>2019-02-13T12:20:37Z</BackupStartTime>
			      <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins10430291/hins5882781_data_20190213201955.tar.gz?OSSAccessKeyId=xxxxxxx&amp;Expires=1231230&amp;Signature=zIBwxxxxxxxxUs5ga3p%2BVxxxxxxxk%3D</BackupDownloadURL>
			      <MetaStatus></MetaStatus>
			      <BackupDBNames>spdb,sys,test20181221,test-20181228,test_20181115,test_20181116</BackupDBNames>
			      <BackupMode>Automated</BackupMode>
			      <BackupSize>2167808</BackupSize>
			      <BackupStatus>Success</BackupStatus>
			      <BackupScale>DBInstance</BackupScale>
		    </Backup>
	  </Items>
	  <TotalBackupSize>8672256</TotalBackupSize>
	  <PageNumber>1</PageNumber>
	  <TotalRecordCount>1</TotalRecordCount>
	  <RequestId>B0E0F374-919F-4BD9-BCAC-AE68122A0D68</RequestId>
	  <PageRecordCount>1</PageRecordCount></DescribeBackupsResponse>

JSON format 

{
	"TotalBackupSize":"8672256",
	"Items":{
		"Backup":[
			{
				"StoreStatus":"Disabled",
				"HostInstanceID":5882781,
				"BackupLocation":"OSS",
				"BackupIntranetDownloadURL":"http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins10430291/hins5882781_data_20190213201955.tar.gz?OSSAccessKeyId=xxxxxxxx&Expires=1231230&Signature=zIBwxxxxxxx5ga3p%2BVxxxxxxxx%3D",
				"BackupType":"FullBackup",
				"DBInstanceId":"rm-uf6wjk5xxxxxxx",
				"BackupEndTime":"2019-02-13T12:22:53Z",
				"BackupMethod":"Physical",
				"BackupId":321020562,
				"BackupStartTime":"2019-02-13T12:20:37Z",
				"BackupDownloadURL":"http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins10430291/hins5882781_data_20190213201955.tar.gz?OSSAccessKeyId=xxxxxxx&Expires=1231230&Signature=zIBwxxxxxxxxUs5ga3p%2BVxxxxxxxk%3D",
				"MetaStatus":"",
				"BackupDBNames":"spdb,sys,test20181221,test-20181228,test_20181115,test_20181116",
				"BackupMode":"Automated",
				"BackupStatus":"Success",
				"BackupSize":2167808,
				"BackupScale":"DBInstance"
			}
		]
	},
	"TotalRecordCount":1,
	"PageNumber":1,
	"RequestId":"B0E0F374-919F-4BD9-BCAC-AE68122A0D68",
	"PageRecordCount":1
}

Error codes

For a list of error codes, visit the API Error Center.