DescribeCrossRegionBackups操作を呼び出して、インスタンスのクロスリージョンデータバックアップファイルを照会できます。

RDSインスタンスのクロスリージョンログバックアップファイルを照会する方法の詳細については、「DescribeCrossRegionLogBackupFiles」をご参照ください。

この操作を呼び出す前に、インスタンスが次のデータベースエンジンのいずれかを実行していることを確認してください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須/任意 例: 説明 
操作 String 必須 DescribeCrossRegionBackups

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

DBInstanceId String 必須 rm-uf6wjk5xxxxxxxxxx

インスタンスの ID です。

RegionId String 必須 cn-hangzhou

インスタンスのリージョン ID です。

CrossBackupRegion String 任意 cn-shanghai

クロスリージョンデータバックアップファイルが保存されているターゲットリージョンのID。

CrossBackupId Integer いいえ 14562

クロスリージョンデータバックアップファイルのID。

説明 CrossBackupIdパラメーターを指定する必要があります。 または、StartTimeおよびEndTimeパラメーターを指定する必要があります。
StartTime String 任意 2019-05-30T12:10:00Z

クエリする期間の開始時刻です。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。 時間は UTC にする必要があります。

EndTime String 任意 2019-06-15T12:10:00Z

クエリする期間の終了時刻を設定します。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。 時間は UTC にする必要があります。

PageSize Integer いいえ 30

各ページで返されるエントリ数。 有効な値:

  • 30
  • 50
  • 100

デフォルト値:30。

PageNumber Integer いいえ 1

返されるページ数。 有効値:0 以外の正の整数。

既定値:1

BackupId Integer いいえ 603524 ***

クロスリージョンデータバックアップファイルのID。

ResourceGroupId String 任意 rg-acfmy *****

リソースグループの ID です。

レスポンスパラメーター

項目 データ型 例: 説明 
EndTime String 2019-06-15T12:10:00Z

照会される時間範囲の終わり。

StartTime String 2019-05-30T12:10:00Z

照会される時間範囲の始まり。

RequestId String 60912B41-7579-4B5D-B289-8856030F0A6A

リクエストの ID です。

PageRecordCount Integer 30

現在のページのクロスリージョンデータバックアップファイルの数。

TotalRecordCount Integer 100

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

PageNumber Integer 1

返されたページ数。 有効値:0 以外の正の整数。

既定値:1

RegionId String cn-hangzhou

インスタンスのリージョン ID です。

項目 アイテムの配列

クロスリージョンデータバックアップファイルの詳細で構成される配列。

項目
ConsistentTime String 2019-06-12T05:44:46Z

クロスリージョンデータバックアップファイルのデータによって示される時点。

DBInstanceStorageType String ssd

ストレージタイプです。 有効な値:

  • local_ssd: ローカルSSD。 これは推奨されるストレージタイプです。
  • cloud_ssd: 標準SSD。
  • cloud_essd: 拡張SSD (ESSD) 。
CrossBackupId Integer 14377

クロスリージョンデータバックアップファイルのID。

BackupType String F

クロスリージョンデータバックアップのタイプ。 有効な値:

  • F: 完全なデータバックアップ
  • I: 増分データバックアップ
BackupStartTime String 2019-05-30T12:10:00Z

クロスリージョンデータのバックアップが開始された時刻。

CrossBackupSetLocation String oss

クロスリージョンデータバックアップファイルが保存されている場所。

InstanceId Integer 8161055

インスタンスの ID です。 このパラメーターは、クロスリージョンデータバックアップファイルを生成するインスタンスがプライマリインスタンスかセカンダリインスタンスかを決定するために使用されます。

CrossBackupDownloadLink String http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/xxxxx

クロスリージョンデータバックアップファイルをダウンロードできる外部URL。

BackupEndTime String 2019-06-15T12:10:00Z

クロスリージョンデータバックアップファイルが生成された時刻。

EngineVersion String 5.6

データベースのバージョン。

BackupSetStatus Integer 0

クロスリージョンデータバックアップのステータス。 有効な値:

  • 0: クロスリージョンのデータバックアップが成功しました。
  • 1: クロスリージョンのデータバックアップに失敗しました。
CrossBackupSetFile String cn-hangzhou_rm-xxxxx_hins81xxx_data_20190612134426_qp.xb

クロスリージョンデータバックアップファイルを含む圧縮パッケージの名前。

BackupSetScale Integer 0

クロスリージョンデータバックアップファイルが生成されるレベル。

  • 0: インスタンスレベルのバックアップ
  • 1: データベースレベルのバックアップ
CrossBackupSetSize Long 5312836

クロスリージョンデータバックアップファイルのサイズ。 単位:バイト

CrossBackupRegion String cn-shanghai

インスタンスのクロスリージョンデータバックアップファイルが保存されているターゲットリージョンのID。

カテゴリー String 高可用性

インスタンスのRDSエディション。 有効な値:

  • 基本: 基本版。
  • HighAvailability: 高可用性エディション。
  • ファイナンス: Enterprise Edition。 このエディションは、中国サイト (aliyun.com) でのみサポートされています。
Engine String mysql

データベースのエンジン。

BackupMethod String P

クロスリージョンデータバックアップファイルの生成に使用されるメソッド。 有効な値:

  • L: 論理バックアップ
  • P: 物理バックアップ
RestoreRegions 文字列の配列 "cn-hangzhou" 、"cn-shanghai"

クロスリージョンデータバックアップファイルを復元できるリージョンで構成される配列。

リクエストの例

http(s):// rds.aliyuncs.com/?Action=DescribeCrossRegionBackups
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&RegionId=cn-hangzhou
&CrossBackupId=14562
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCrossRegionBackupsResponse>
<アイテム>
<アイテム>
<CrossBackupSetFile>cn-hangzhou_rm-bpxxxxx_hins798xxxx_data_20190611125201.tar.gz</CrossBackupSetFile>
<BackupSetScale>0</BackupSetScale>
<BackupType>F</BackupType>
<InstanceId>7980000</InstanceId>
<CrossBackupId>14358</CrossBackupId>
<BackupEndTime>2019-06-11T04:55:02Z</BackupEndTime>
<BackupMethod>P</BackupMethod>
<CrossBackupSetLocation>oss</CrossBackupSetLocation>
<CrossBackupSetSize>2179643</CrossBackupSetSize>
<Engine>mysql</Engine>
<BackupStartTime>2019-06-11T04:52:46Z</BackupStartTime>
<CrossBackupDownloadLink>http://rdsddrbak-zb.oss-cn-zhangjiakou.aliyuncs.com/cn-hangzhou_rm-bpxxxxx_hins7986073_data_20190611125201.tar.gz?OSSAccessKeyId=LTAxxxxx&Expires=1560501641&Signature=laK0kxxxxx%3D</CrossBackupDownloadLink>
<Category> 高可用性 </Category>
<CrossBackupRegion>cn-zhangjiakou</CrossBackupRegion>
<RestoreRegions>
<RestoreRegion>cn-hangzhou</RestoreRegion>
<RestoreRegion>cn-zhangjiakou</RestoreRegion>
</RestoreRegions>
<EngineVersion>5.7</EngineVersion>
<DBInstanceStorageType>ssd</DBInstanceStorageType>
</アイテム>
</アイテム>
<TotalRecordCount>1</TotalRecordCount>
<PageNumber>1</PageNumber>
<RequestId>60912B41-7579-4B5D-B289-8856030F0A6A</RequestId>
<RegionId>cn-hangzhou</RegionId>
<EndTime>2019-06-11T08:00:00Z</EndTime>
<StartTime>2019-06-10T00:00:00Z</StartTime>
<PageRecordCount>30</PageRecordCount>
    </DescribeCrossRegionBackupsResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "アイテム" : {
    "アイテム" : [ {
      "CrossBackupSetFile" : "cn-hangzhou_rm-bpxxxxx_hins798xxxx_data_20190611125201.tar.gz" 、
      "BackupSetScale" : 0、
      "BackupType" : "F" 、
      "InstanceId" : 7980000、
      "CrossBackupId" : 14358、
      "BackupEndTime" : "2019-06-11T04:55:02Z" 、
      "BackupMethod" : "P" 、
      "CrossBackupSetLocation" : "oss" 、
      "CrossBackupSetSize" : 2179643、
      "エンジン" : "mysql" 、
      "BackupStartTime" : "2019-06-11T04:52:46Z" 、
      "CrossBackupDownloadLink" : "http://rdsddrbak-zb.oss-cn-zhangjiakou.aliyuncs.com/cn-hangzhou_rm-bpxxxxx_hins7986073_data_20190611125201.tar.gz?OSSAccessKeyId=LTAxxxxx&Expires=1560501641&Signature=laK0kxxxxx%3D" 、
      "カテゴリ" : "HighAvailability" 、
      "CrossBackupRegion" : "cn-zhangjiakou" 、
      "RestoreRegions" : {
        "RestoreRegion" : [ "cn-hangzhou" 、"cn-zhangjiakou"]
      },
      "EngineVersion" : "5.7" 、
      "DBInstanceStorageType" : "ssd"
    } ]
  },
  "TotalRecordCount" : 1、
  "PageNumber" : 1,
  "RequestId" : "60912B41-7579-4B5D-B289-8856030F0A6A" 、
  "RegionId" : "cn-hangzhou" 、
  "EndTime" : "2019-06-11T08:00:00Z" 、
  "StartTime" : "2019-06-10T00:00:00Z" 、
  "PageRecordCount" : 30
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明 
400 InvalidRegion. フォーマット 指定されたリージョンは無効です。 指定されたリージョンが無効な場合に返されるエラーメッセージ。
400 InvalidStartTime. フォーマット 指定された開始時刻は無効です。 指定された開始時間が無効な場合に返されるエラーメッセージ。
400 InvalidEndTime.Format 指定された終了時刻は無効です。 指定された終了時刻が無効な場合に返されるエラーメッセージ。 有効な値を指定して、もう一度お試しください。
400 InvalidTime. フォーマット 指定された時間は無効です。 時間形式が無効な場合に返されるエラーメッセージ。
403 CrossBackupNotSupport 指定されたリージョンは、クロスリージョンバックアップをサポートしていません。 指定されたリージョンがクロスリージョンバックアップ機能をサポートしていない場合に返されるエラーメッセージ。
404 InvalidDBInstance.NotFound 指定されたインスタンスが存在しないか、サポートされていません。 インスタンスが見つからない、削除されている、または操作をサポートしていない場合に返されるエラーメッセージ。

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