この操作を呼び出して、指定した ApsaraDB for PolarDB クラスターのバックアップ情報を照会できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須 / 任意 例 説明
DBClusterId String 必須 pc-bpxxxxxxx

ApsaraDB for PolarDB クラスターの ID。
EndTime String 必須 2019-07-27T15:00Z

バックアップデータを照会する期間の終了日時を指定します。 終了日時は開始日時よりも後の日時でなければなりません。 時間は YYYY-MM-DDThh:mmZ 形式で指定します。 タイムゾーンは UTC とする必要があります。

StartTime String 必須 2019-07-26T15:00Z

バックアップデータを照会する期間の開始日時を指定します。 時間は YYYY-MM-DDThh:mmZ 形式で指定します。 タイムゾーンは UTC とする必要があります。

AccessKeyId String 任意 key-test

Alibaba Cloud から提供された AccessKey ID。
Action String 任意 DescribeBackups

実行する操作。 この値を DescribeBackups に設定します。
BackupId String 任意 42395xxxx

バックアップセットの ID。
BackupMode String 任意 Manual

バックアップタイプ。 設定可能な値は次のとおりです。

  • Automated：自動バックアップ
  • Manual：手動バックアップ
BackupStatus String 任意 Success

バックアップタスクのステータス。 設定可能な値は次のとおりです。

  • Success: バックアップタスクが完了しています。
  • Failed: バックアップタスクが失敗しました。
PageNumber Integer 任意 1

返されるページのページ番号。 有効な値：0 以外の正の整数。

デフォルト値：1
PageSize Integer 任意 30

返される各ページのエントリ数。 設定可能な値は次のとおりです。

  • 30
  • 50
  • 100

デフォルト値：30

レスポンスパラメーター

パラメーター データ型 例 説明
Items

バックアップのリスト。
Backup

バックアップの詳細。
BackupEndTime String 2019-07-27T07:31:23Z

このバックアップタスクが終了した時刻。 時刻は UTC で表示されます。

BackupId String 42395xxxx

バックアップセットの ID。
BackupMethod String Snapshot

バックアップの方法。 スナップショットバックアップのみがサポートされています。 値は Snapshot です。
BackupMode String Manual

バックアップタイプ。 有効な値は次のとおりです。

Automated：自動バックアップ

Manual：手動バックアップ
BackupSetSize String 3572498432

バックアップファイルのサイズ。 単位：バイト。

注 スナップショットファイルの削除後にリリースされるスペースは、スナップショット間で共有されるブロックであるため、このファイルのサイズよりもはるかに小さくなります。
BackupStartTime String 2019-07-27T07:31:13Z

このバックアップタスクが開始した時刻。 時刻は UTC で表示されます。

BackupStatus String Success

バックアップタスクのステータス。 有効な値は次のとおりです。

  • Success：バックアップタスクが完了しています。
  • Failed：バックアップタスクが失敗しました。
BackupType String FullBackup

バックアップタイプ。 フルバックアップのみがサポートされています。 値は FullBackup です。
DBClusterId String pc-bpxxxxxxx

ApsaraDB for PolarDB クラスターの ID。
PageNumber String 1

返されたページのページ番号。
PageRecordCount String 2

ページごとの返されるエントリ数。
RequestId String E22FB172-F0AB-42FF-A6D0-115065D64971

リクエストの ID。
TotalRecordCount String 2

返されたエントリの総数。

例

リクエストの例


http(s)://[Endpoint]/? Action=DescribeBackups
&DBClusterId=pc-bpxxxxxxx
&EndTime=2019-07-27T15:00Z
&StartTime=2019-07-26T15:00Z
&<Common request parameters>

通常のレスポンス例

XML 形式 

<DescribeBackupsResponse>
  <Items>
        <Backup>
              <StoreStatus>Enabled</StoreStatus>
              <BackupType>FullBackup</BackupType>
              <BackupSetSize>3572498432</BackupSetSize>
              <BackupEndTime>2019-07-27T07:31:23Z</BackupEndTime>
              <BackupMethod>Snapshot</BackupMethod>
              <BackupMode>Manual</BackupMode>
              <BackupStatus>Success</BackupStatus>
              <DBClusterId>pc-bpxxxxxxx</DBClusterId>
              <BackupStartTime>2019-07-27T07:31:13Z</BackupStartTime>
              <BackupId>423957113</BackupId>
        </Backup>
        <Backup>
              <StoreStatus>Enabled</StoreStatus>
              <BackupType>FullBackup</BackupType>
              <BackupSetSize>3572498432</BackupSetSize>
              <BackupEndTime>2019-07-27T07:27:18Z</BackupEndTime>
              <BackupMethod>Snapshot</BackupMethod>
              <BackupMode>Manual</BackupMode>
              <BackupStatus>Success</BackupStatus>
              <DBClusterId>pc-bpxxxxxxx</DBClusterId>
              <BackupStartTime>2019-07-27T07:27:08Z</BackupStartTime>
              <BackupId>423955591</BackupId>
        </Backup>
  </Items>
  <PageNumber>1</PageNumber>
  <TotalRecordCount>2</TotalRecordCount>
  <RequestId>E22FB172-F0AB-42FF-A6D0-115065D64971</RequestId>
  <PageRecordCount>2</PageRecordCount>
</DescribeBackupsResponse>

JSON 形式 

{
	"Items":{
		"Backup":[
			{
				"StoreStatus":"Enabled",
				"BackupType":"FullBackup",
				"BackupEndTime":"2019-07-27T07:31:23Z",
				"BackupSetSize":3572498432,
				"BackupMode":"Manual",
				"BackupMethod":"Snapshot",
				"DBClusterId":"pc-bpxxxxxxx",
				"BackupStatus":"Success",
				"BackupId":423957113,
				"BackupStartTime":"2019-07-27T07:31:13Z"
			},
			{
				"StoreStatus":"Enabled",
				"BackupType":"FullBackup",
				"BackupEndTime":"2019-07-27T07:27:18Z",
				"BackupSetSize":3572498432,
				"BackupMode":"Manual",
				"BackupMethod":"Snapshot",
				"DBClusterId":"pc-bpxxxxxxx",
				"BackupStatus":"Success",
				"BackupId":423955591,
				"BackupStartTime":"2019-07-27T07:27:08Z"
			}
		]
	},
	"TotalRecordCount":2,
	"PageNumber":1,
	"RequestId":"E22FB172-F0AB-42FF-A6D0-115065D64971",
	"PageRecordCount":2
}

エラーコード

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