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

説明 データバックアップファイルは、 BackupStatus値が Successの場合にのみ、データを復元するために使用できます。

デバッグ

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

リクエストパラメーター

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

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

DBInstanceId String 必須 rm-uf6wjk5xxxxxxx

インスタンスの ID です。

BackupId String 任意 327329803

データバックアップファイルのID。

BackupStatus String 任意 成功

データバックアップファイルのステータス。 有効な値：

  • 成功
  • 失敗しました
BackupMode String 任意 Automated

データバックアップファイルのバックアップモード。有効な値：

  • 自動化
  • マニュアル
StartTime String 任意 2011-06-01T16:00Z

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

EndTime String 任意 2011-06-15T16:00Z

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

PageSize Integer いいえ 30

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

  • 30
  • 50
  • 100

既定値： 30.

PageNumber Integer いいえ 1

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

既定値：1

BackupType String 任意 FullBackup

データバックアップファイルのバックアップタイプ。 有効な値：

  • FullBackup
  • IncrementalBackup
ResourceGroupId String 任意 rg-acfmy*****

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

レスポンスパラメーター

項目 データ型 例: 説明
RequestId String 1A6D328C-84B8-40DC-BF49-6C73984D7494

リクエストの ID です。

TotalEcsSnapshotSize Long 0

インスタンスのスナップショットチェーンのサイズ。 単位：バイト

PageRecordCount String 30

ページ上のデータバックアップファイルの数。

TotalRecordCount String 100

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

PageNumber String 1

返されたページ数。

項目 バックアップの配列

返されたデータバックアップファイルの詳細で構成される配列。

バックアップ
StorageClass String 0

データバックアップファイルのストレージクラス。 有効な値：

  • 0: レギュラーストレージ
  • 1: アーカイブ記憶装置
暗号化 String {}

データバックアップファイルの暗号化情報。

BackupStatus String 成功

データバックアップファイルのステータス。

StoreStatus String 無効

データバックアップファイルの削除の可否を示す。有効な値：

  • 有効: データバックアップファイルを削除できます。
  • 無効: データバックアップファイルは削除できません。
ConsistentTime Long 1576506856

データバックアップファイル内のデータが一貫している時点。 このパラメータの戻り値は、タイムスタンプである。

説明 インスタンスがMySQL 5.6を実行する場合、タイムスタンプが返されます。 そうでなければ、値0が返される。
BackupType String FullBackup

データバックアップファイルのバックアップタイプ。 有効な値：

  • FullBackup
  • IncrementalBackup
CopyOnlyBackup String 0

データバックアップファイルのバックアップモード。 有効な値：

  • 0: 標準モード。 このモードは、完全バックアップと増分バックアップをサポートします。
  • 1: コピー専用モード。 このモードは完全バックアップのみをサポートします。
    説明 このパラメーターは、インスタンスがSQL Serverを実行している場合にのみ返されます。
BackupEndTime String 2019-02-13T12:20:00Z

バックアップタスクの終了時刻。 時間はyyyy-MM-dd T HH:mm Z形式のISO 8601標準に従います。 時刻は UTC で表示されます。

メタステータス String OK

個々のデータベースまたはテーブルの復元に使用されるデータバックアップファイルのステータス。 有効な値：

  • OK: データバックアップファイルは正常です。
  • LARGE: データバックアップファイルに異常に多数のテーブルが含まれています。 個々のデータベースやテーブルの復元には使用できません。
  • 空: データバックアップファイルは、失敗したバックアップタスクから生成されます。
説明 空の文字列が返された場合、データバックアップファイルを使用して個々のデータベースまたはテーブルを復元することはできません。
BackupInitiator String システム

バックアップタスクの開始者。 有効な値：

  • システム
  • ユーザー
BackupIntranetDownloadURL String http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx

内部ネットワーク経由でデータバックアップファイルをダウンロードするために使用されるURL。 データバックアップファイルをダウンロードできない場合は、nullが返されます。

説明 たとえば、インスタンスがSQL Serverを実行し、BackupMethodパラメーターが Snapshotに設定されている場合、nullが返されます。
BackupMethod String Physical

データバックアップファイルの生成に使用されるメソッド。 有効な値：

  • 論理: 論理バックアップ
  • Physical: 物理バックアップ
  • Snapshot: スナップショットバックアップ
BackupStartTime String 2019-02-03T12:20:00Z

バックアップタスクの開始時刻。 時間はyyyy-MM-dd T HH:mm Z形式のISO 8601標準に従います。 時刻は UTC で表示されます。

BackupDownloadURL String http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx

インターネット経由でデータバックアップファイルをダウンロードするために使用されるURL。 データバックアップファイルをダウンロードできない場合は、nullが返されます。

説明 たとえば、インスタンスがSQL Serverを実行し、BackupMethodパラメーターが Snapshotに設定されている場合、nullが返されます。
IsAvail Integer 1

データバックアップファイルが使用可能かどうかを示します。 有効な値：

  • 0: データバックアップファイルは使用できません。
  • 1: データバックアップファイルが利用可能です。
BackupId String 321020562

データバックアップファイルのID。

HostInstanceID String 5882781

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

BackupSize Long 2167808

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

BackupMode String Automated

データバックアップファイルのバックアップモード。 有効な値：

  • 自動化
  • マニュアル
DBInstanceId String rm-uf6wjk5xxxxxxx

インスタンスの ID です。

チェックサム String 1835830439 **********

チェックサム。 このパラメータの値は、CRC64アルゴリズムを使用して計算されます。

BackupDownloadLinkByDB BackupDownloadLinkByDBの配列

個々のデータベースのデータバックアップファイルをダウンロードできるURL。

BackupDownloadLinkByDB
IntranetDownloadLink String https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires= *****&dbList=tb1

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

データベース String dbs

データベースの名前。

DownloadLink String https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires= *****&dbList=tb1

データバックアップファイルをダウンロードできるパブリックURL。

ResourceGroupId String rg-acfmy *****

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

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=DescribeBackups
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<共通リクエストパラメーター>

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

XML 形式

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

<DescribeBackupsResponse>
    <TotalRecordCount>100</TotalRecordCount>
    <TotalEcsSnapshotSize>0</TotalEcsSnapshotSize>
    <PageRecordCount>30</PageRecordCount>
    <RequestId>1A6D328C-84B8-40DC-BF49-6C73984D7494</RequestId>
    <ページ番号> 1 </ PAGENUMBER>
    <Items>
        <Backup>
            <BackupMethod>Physical</BackupMethod>
            <BackupInitiator> システム </BackupInitiator>
            <StorageClass>0</StorageClass>
            <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx</BackupIntranetDownloadURL>
            <BackupSize>2167808</BackupSize>
            <BackupMode>Automated</BackupMode>
            <BackupId>321020562</BackupId>
            <IsAvail>1</IsAvail>
            <Encryption >{}</Encryption>
            <HostInstanceID>5882781</HostInstanceID>
            <StoreStatus> 無効 </StoreStatus>
            <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx</BackupDownloadURL>
            <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
            <CopyOnlyBackup>0</CopyOnlyBackup>
            <BackupEndTime>2019-02-13T12:20:00Z</BackupEndTime>
            <ConsistentTime>1576506856</ConsistentTime>
            <BackupStartTime>2019-02-03T12:20:00Z</BackupStartTime>
            <MetaStatus>OK</MetaStatus>
            <BackupType>FullBackup</BackupType>
            <BackupStatus>Success</BackupStatus>
            <BackupDownloadLinkByDB>
                <BackupDownloadLinkByDB>
                    <DownloadLink>https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires= *****&dbList=tb1</DownloadLink>
                    <IntranetDownloadLink>https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires= *****&dbList=tb1</IntranetDownloadLink>
                    <DataBase>dbs</DataBase>
                </BackupDownloadLinkByDB>
            </BackupDownloadLinkByDB>
        </Backup>
    </アイテム>
</DescribeBackupsResponse>

JSON 形式

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

{
  "DescribeBackupsResponse" : {
    "TotalRecordCount" : 100、
    "TotalEcsSnapshotSize" : 0、
    "PageRecordCount" : 30、
    "RequestId" : "1A6D328C-84B8-40DC-BF49-6C73984D7494" 、
    "PageNumber" : 1,
    "アイテム" : {
      "バックアップ" : {
        "BackupMethod" : "Physical" 、
        "BackupInitiator" : "システム" 、
        "StorageClass" : 0、
        "BackupIntranetDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx" 、
        "BackuppSize" : 2167808、
        "BackupMode" : "Automated" 、
        "BackupId" : 321020562、
        "IsAvail" : 1、
        "暗号化" : "{}" 、
        "HostInstanceID" : 5882781、
        "StoreStatus" : "Disabled" 、
        "BackupDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx" 、
        "DBInstanceId" : "rm-uf6wjk5xxxxxxx" 、
        "CopyOnlyBackup" : 0、
        "BackupEndTime" : "2019-02-13T12:20:00Z" 、
        "ConsistentTime" : 1576506856、
        "BackupStartTime" : "2019-02-03T12:20:00Z" 、
        "MetaStatus" : "OK" 、
        "BackupType" : "FullBackup" 、
        "BackupStatus" : "Success" 、
        "BackupDownloadLinkByDB" : {
          "BackupDownloadLinkByDB" : {
            "DownloadLink" : "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires= *****&dbList=tb1" 、
            "IntranetDownloadLink" : "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires= *****&dbList=tb1" 、
            "DataBase" : "dbs"
          }
        }
      }
    }
  }
}

エラーコード

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