DescribeBackupDBs - - Alibaba Cloud ドキュメントセンター

ApsaraDB for MongoDB インスタンスのデータベース復元を実行する前に、この操作を呼び出して、指定された時間にデータベースを照会したり、バックアップセットに含めたりすることができます。

説明

CreateDBInstance 操作を呼び出して、単一のデータベースを復元することができます。詳細については、「 ApsaraDB for MongoDB でデータベースを復元する」をご参照ください。

この API を呼び出す前に、次の要件を満たしている必要があります。

インスタンスの作成日は、2019 年 3 月 26 日以降であること。
インスタンスは、中国 (青島)、中国 (北京)、中国 (張家口)、中国 (フフホト)、中国 (杭州)、中国 (上海)、中国 (深セン)、またはシンガポールにあること。他のリージョンはサポートされていません。
インスタンスはレプリカセットインスタンスであること。
インスタンスのバージョンは 3.4 または 4.0 であること。
インスタンスのストレージエンジンは WiredTiger であること。 RocksDB および TerarkDB はサポートされていません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。この API は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、各種 SDK に用意されている API のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	データ型	必須項目	例	説明
SourceDBInstance	String	はい	dds-bpxxxxxxxx	ソースインスタンスの ID。
Action	String	いいえ	DescribeBackupDBs	実行する操作。値を DescribeBackups に設定します。
PageNumber	Integer	いいえ	1	返されるページ数。有効値：0 以外の正の整数。デフォルト値：1。
PageSize	Integer	いいえ	30	返される各ページのエントリ数。有効値： 30、50、100。デフォルト値： 30。
RestoreTime	String	いいえ	2014-05-26T12:00:00Z	インスタンスが復元される時刻。 the yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC である必要があります。説明過去 7 日以内であればいつでも許可されます。時刻は現在の時刻より前で、データベースが作成された時刻より後である必要があります。このパラメーターまたは BackupId パラメーターのいずれかを指定する必要があります。
BackupId	String	いいえ	5664xxxx	バックアップ ID。説明 DescribeBackups を呼び出して、バックアップ ID を照会できます。このパラメーターまたは RestoreTime パラメーターのいずれかを指定する必要があります。
AccessKeyId	String	いいえ	LTAI****************	Alibaba Cloud から提供された AccessKey ID。

レスポンスパラメーター

パラメーター	データ型	例	説明
データベース			データベースのリスト。
DBName	String	mongodbtest	データベースの名前。
PageNumber	Integer	1	返されたページの数。
TotalCount	Integer	5	データベースの数
PageSize	Integer	30	返されるエントリの 1 ページあたりの数。
RequestId	String	1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455	リクエストの ID。

例

リクエストの例


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

通常のレスポンス例

XML 形式

<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 形式

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	現在のインスタンスタイプで、該当の操作がサポートされていない場合に返されるエラーメッセージ。

エラーコードのリストについては、「API エラーセンター」をご参照ください。