DescribeBackupDBs

Before you call this operation, ensure that the following requirements are met:

• The instance is created after March 26, 2019.
• The instance is located in China (Qingdao), China (Beijing), China (Zhangjiakou-Beijing Winter Olympics), China (Hohhot), China (Hangzhou), China (Shanghai), China (Shenzhen), or Singapore (Singapore). Other regions are not supported.
• The instance is a replica set instance.
• The instance version is 3.4 or 4.0.
• The storage engine of the instance is WiredTiger. RocksDB and TerarkDB are not supported.

Request parameters

Response parameters

Samples

Sample requests

http(s)://mongodb.aliyuncs.com/? Action=DescribeBackupDBs
&SourceDBInstance=dds-bpxxxxxxxx
&RestoreTime=2019-08-22T12:00:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeBackupDBsResponse>
	  <Databases>
		    <Database>
			      <DBName>admin</DBName>
		    </Database>
		    <Database>
			      <DBName>config</DBName>
		    </Database>
		    <Database>
			      <DBName>mongodbtest</DBName>
		    </Database>
		    <Database>
			      <DBName>db1</DBName>
		    </Database>
		    <Database>
			      <DBName>db2</DBName>
		    </Database>
	  </Databases>
	  <PageNumber>1</PageNumber>
	  <TotalCount>5</TotalCount>
	  <PageSize>30</PageSize>
	  <RequestId>1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455</RequestId>
</DescribeBackupDBsResponse>

JSON format

{
	"PageNumber":1,
	"Databases":{
		"Database":[
			{
				"DBName":"admin"
			},
			{
				"DBName":"config"
			},
			{
				"DBName":"mongodbtest"
			},
			{
				"DBName":"db1"
			},
			{
				"DBName":"db2"
			}
		]
	},
	"TotalCount":5,
	"PageSize":30,
	"RequestId":"1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455"
}

Error codes

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