この API は、MongoDB インスタンスのバックアップをクエリする場合に呼び出すことができます。

デバッグ

OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。

リクエストパラメータ

パラメータ データ型 必須 説明
StartTime String はい 2019-03-12T12:00Z

クエリの開始時刻。 形式:yyyy-MM-ddTHH:mm:Z。

EndTime String はい 2019-03-13T12:00Z

クエリの終了時刻。 開始時刻より遅い時刻である必要があります。 形式:yyyy-MM-ddTHH: mmZ。

DBInstanceId String はい dds-bpxxxxxxxx

インスタンス ID。

このパラメーターをシャードクラスターインスタンスの ID に設定した場合、同時に NodeId パラメーターも指定する必要があります。
Action String いいえ DescribeBackups

実行する操作。 値を DescribeBackups に設定します。

NodeId String いいえ d-bpxxxxxxxx

シャードクラスターインスタンス内の Shard の ID。

このパラメーターは、DBInstanceId がシャードクラスターインスタンスのIDである場合にのみ使用できます。
BackupId String いいえ 5664xxxx

バックアップ ID。

PageNumber Integer No 1

ページ番号 。 有効値:0 以外の正の整数。 デフォルト値:1

PageSize Integer いいえ 30

各ページの履歴件数。 有効値:30、50、100。デフォルト値:30

AccessKeyId String いいえ LTAIgbTGpxxxxxx

Alibaba Cloud から提供された AccessKey ID。

レスポンスパラメータ

パラメータ タイプ 説明
PageNumber Integer 1

ページ番号 。

PageSize Integer 30

各ページの履歴件数。

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

リクエスト ID。

TotalCount Integer 1

バックアップの総数。

Backups

返されたすべてのバックアップの詳細リスト。

└BackupDBNames String mongodbtest, new, test

バックアップデータベースの名前。

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

バックアップファイルのダウンロード URL。 ダウンロード URL が利用できない場合、このパラメーターは空の文字列になります。

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

バックアップの終了時刻。 形式:yyyy-MM-ddTHH: mm:ssZ。

└BackupId Integer 11111111

バックアップ ID。

└BackupMethod String Physical

バックアップ方法。

  • Snapshot
  • Physical
  • Logical
└BackupMode String Automated

バックアップモード。

  • Automated
  • Manual
└BackupSize Long 335520510

バックアップファイルのサイズ。 単位: Bytes。

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

バックアップの開始時間。 形式:yyyy-MM-ddTHH: mm:ssZ。

└BackupStatus String Success

バックアップの状態。

  • Success:バックアップは成功しました。
  • Failed:バックアップに失敗しました。
└BackupType String FullBackup

バックアップの種類。

  • FullBackup
  • IncrementalBackup

リクエストの例


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

通常のレスポンスの例

XML 形式

<DescribeBackupsResponse>
  <PageNumber>1</PageNumber>
  <TotalCount>1</TotalCount>
  <PageSize>30</PageSize>
  <RequestId>8925E66F-1971-4C8C-90A7-F93BF1867E25</RequestId> 
  <Backups>
    <Backup>
      <BackupDownloadURL>http://xxxxx.oss-cn-hangzhou.aliyuncs.com/xxxxx/xxxxxx.tar.gz</BackupDownloadURL>
      <BackupType>FullBackup</BackupType>
      <BackupDBNames>mongodbtest,new,test</BackupDBNames>
      <BackupEndTime>2019-03-13T04:34:57Z</BackupEndTime>
      <BackupMethod>Physical</BackupMethod> 
      <BackupMode>Automated</BackupMode>
      <BackupSize>204595200</BackupSize> 
      <BackupStatus>Success</BackupStatus> 
      <BackupStartTime>2019-03-13T04:32:42Z</BackupStartTime> 
      <BackupId>11111111</BackupId>
    </Backup> 
  </Backups> 
</DescribeBackupsResponse> 

JSON 形式

{
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":30,
	"RequestId":"8925E66F-1971-4C8C-90A7-F93BF1867E25",
	"Backups":{
		"Backup":[
			{
				"BackupDownloadURL":"http://xxxxx.oss-cn-hangzhou.aliyuncs.com/xxxxx/xxxxxx.tar.gz",
				"BackupType":"FullBackup",
				"BackupDBNames":"mongodbtest,new,test",
				"BackupEndTime":"2019-03-13T04:34:57Z",
				"BackupMode":"Automated",
				"BackupMethod":"Physical",
				"BackupStatus":"Success",
				"BackupSize":204595200,
				"BackupId":11111111,
				"BackupStartTime":"2019-03-13T04:32:42Z"
			}
		]
	}
}

エラーコード

エラーコードの表示