Queries the backups of an ApsaraDB for MongoDB instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeBackups

The operation that you want to perform. Set the value to DescribeBackups.

StartTime String Yes 2019-03-12T12:00Z

The start of the time range that is specified to query the operational log. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

EndTime String Yes 2019-03-13T12:00Z

The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

DBInstanceId String Yes dds-bpxxxxxxxx

The ID of the instance.

Note If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.
NodeId String No d-bpxxxxxxxx

The ID of the shard node in the sharded cluster instance.

Note This parameter takes effect only when you set the DBInstanceId parameter to the ID of a sharded cluster instance.
BackupId String No 5664xxxx

The ID of the backup set.

PageNumber Integer No 1

The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.

PageSize Integer No 30

The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of an instance.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The number of the page returned.

PageSize Integer 30

The number of entries to return on each page.

RequestId String 8925E66F-1971-4C8C-90A7-F93BF1867E25

The ID of the request.

TotalCount Integer 1

The total number of backup files that were returned.

Backups Array

Details about backup sets.

Backup
BackupDBNames String mongodbtest,new,test

The name of the database that has been backed up.

BackupDownloadURL String http://xxxxx.oss-cn-hangzhou.aliyuncs.com/xxxxx/hinsxxxxx_data_xxxxx.tar.gz

The Internet download URL of the backup file. If the download URL is unavailable, this parameter is an empty string.

BackupEndTime String 2019-03-13T04:34:57Z

The end of the backup time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

BackupId Integer 11111111

The ID of the backup set.

BackupIntranetDownloadURL String http://xxxxx.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx/xxxxx.tar.gz

The internal download URL of the backup file.

Note You can download the backup file by using this URL on the Elastic Compute Service (ECS) instance that is connected to the ApsaraDB for MongoDB instance. The ECS instance and ApsaraDB for MongoDB instance must be in the classic network of the same region or in the same virtual private cloud (VPC).
BackupMethod String Physical

The backup method. Valid values:

  • Snapshot
  • Physical
  • Logical
BackupMode String Automated

The backup mode.

  • Automated: automatic backup.
  • Manual: manual backup.
BackupSize Long 335520510

The size of the backup file. Unit: bytes.

BackupStartTime String 2019-03-13T04:32:42Z

The beginning of the backup time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

BackupStatus String Success

The status of the backup. Valid values:

  • Success: The backup task is successful.
  • Failed: The backup task failed.
BackupType String FullBackup

The backup method.

  • FullBackup: full backup.
  • IncrementalBackup: incremental backup.

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=DescribeBackups
&StartTime=2019-03-12T12:00Z
&EndTime=2019-03-13T12:00Z
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>

Sample success responses

XML format

<DescribeBackupsResponse>
	  <PageNumber>1</PageNumber>
	  <TotalCount>1</TotalCount>
	  <PageSize>30</PageSize>
	  <RequestId>09308D8E-136C-4053-89D8-51350248C31B</RequestId>
	  <Backups>
		    <Backup>
			      <BackupDownloadURL>http://xxxxx.oss-cn-hangzhou.aliyuncs.com/xxxxx/xxxxx.tar.gz</BackupDownloadURL>
			      <BackupIntranetDownloadURL>http://xxxxx.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx/xxxxx.tar.gz</BackupIntranetDownloadURL>
			      <BackupType>FullBackup</BackupType>
			      <BackupDBNames>mongousertest</BackupDBNames>
			      <BackupEndTime>2019-05-27T14:27:11Z</BackupEndTime>
			      <BackupMethod>Physical</BackupMethod>
			      <BackupMode>Automated</BackupMode>
			      <BackupSize>25849856</BackupSize>
			      <BackupStatus>Success</BackupStatus>
			      <BackupStartTime>2019-05-27T14:24:55Z</BackupStartTime>
			      <BackupId>11111</BackupId>
		    </Backup>
	  </Backups>
</DescribeBackupsResponse>

JSON format

{
	"PageNumber": 1,
	"TotalCount": 1,
	"PageSize": 30,
	"RequestId": "09308D8E-136C-4053-89D8-51350248C31B",
	"Backups": {
		"Backup": [
			{
				"BackupDownloadURL": "http://xxxxx.oss-cn-hangzhou.aliyuncs.com/xxxxx/xxxxx.tar.gz",
				"BackupIntranetDownloadURL": "http://xxxxx.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx/xxxxx.tar.gz",
				"BackupType": "FullBackup",
				"BackupDBNames": "mongousertest",
				"BackupEndTime": "2019-05-27T14:27:11Z",
				"BackupMethod": "Physical",
				"BackupMode": "Automated",
				"BackupSize": 25849856,
				"BackupStatus": "Success",
				"BackupStartTime": "2019-05-27T14:24:55Z",
				"BackupId": 11111
			}
		]
	}
}

Error codes

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