DescribeMetaList操作を呼び出して、特定のデータバックアップファイル内の復元可能なデータベースとテーブルに関する情報を照会できます。

RestoreTable APIを呼び出してApsaraDB RDS for MySQLインスタンスの個々のデータベースまたはテーブルを復元する前に、このAPIを呼び出して、復元可能なデータベースとテーブルに関する情報を照会できます。 詳細については、「ApsaraDB RDS For MySQLインスタンスの個々のデータベースとテーブルの復元」をご参照ください。

説明 この操作は、インスタンスがローカルSSDを備えたRDS High-availability EditionでMySQL 8.0、MySQL 5.7、またはMySQL 5.6を実行している場合にのみサポートされます。

デバッグ

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

リクエストパラメーター

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

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

ClientToken String 任意 ETnLKlblzczshOTUbOCzxxxxxxxxxx

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、生成されたトークンが異なるリクエスト間で一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

DBInstanceId String 必須 rm-uf6wjk5xxxxxxx

インスタンスの ID です。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。

RestoreType String 任意 BackupSetID

データの復元に使用されるメソッド。 有効な値:

  • BackupSetID: データバックアップファイルからデータを復元します。 この値を使用する場合は、BackupSetIDパラメーターも指定する必要があります。
  • RestoreTime: データは特定の時点に復元されます。 この値を使用する場合は、RestoreTimeパラメーターも指定する必要があります。

デフォルト値: BackupSetID

BackupSetID Integer いいえ 14358

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

説明 このパラメーターは、RestoreTypeパラメーターをBackupSetIDに設定した場合に必要です。
RestoreTime String 任意 2019-05-30T03:29:10Z

データを復元する時点。 指定された時点は、現在の時刻より前である必要があります。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。 時間は UTC にする必要があります。 DescribeBackups操作を呼び出して、復元可能な時間範囲を照会できます。

説明 このパラメーターは、RestoreTypeパラメーターをRestoreTimeに設定した場合に必要です。
GetDbName String 任意 testdb1

クエリするデータベースの名前。 ApsaraDB RDSは、このパラメーターの値に基づいて完全一致を実装し、一致したデータベースの名前とデータベースに含まれるすべてのテーブルの名前を返します。

説明 このパラメーターを空のままにすると、ApsaraDB RDSはインスタンスで作成されたすべてのデータベースを返します。
Pattern String 任意 test

クエリするデータベースの名前。 ApsaraDB RDSは、このパラメーターの値に基づいてファジー一致を実装し、一致したデータベースの名前のみを返します。

説明 たとえば、値をtestに設定した場合、ApsaraDB RDSはtestdb1testdb2を返します。 次に、GetDbNameパラメーターを指定して、必要なデータベースのテーブルを照会できます。
PageSize Integer いいえ 1

各ページで返されるエントリ数。 既定値:1

説明 このパラメーターは、PageIndexパラメーターを指定した場合にのみ有効です。
PageIndex Integer いいえ 1

返されるページ数。 有効値: 非ゼロの正の整数。 デフォルト値: 1

説明 このパラメーターは、PageSizeパラメーターを指定した場合にのみ有効です。
ResourceGroupId String 任意 rg-acfmy *****

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

レスポンスパラメーター

項目 データ型 例: 説明
DBInstanceName String rm-uf6wjk5xxxxxxx

インスタンスの名前です。

TotalPageCount Integer 1

返されたページの総数。

RequestId String 60F9A12A-16B8-4728-B099-4CA38D32C31C

リクエストの ID です。

PageRecordCount Integer 1

現在のページで返されたエントリの数。

TotalRecordCount Integer 1

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

PageNumber Integer 1

返されたページの数を示します。

項目 メタの配列

データバックアップファイルにデータが含まれているデータベースとテーブルに関する情報で構成される配列。

メタ未満です。
String test1

テーブルの名前。

データベース String testdb1

データベースの名前。

サイズ String 64

テーブルのサイズ。 (単位:KB)

リクエストの例

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

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

XML 形式

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

<DescribeMetaList>
    <TotalPageCount>1</TotalPageCount>
    <TotalRecordCount>1</TotalRecordCount>
    <PageRecordCount>1</PageRecordCount>
    <RequestId>60F9A12A-16B8-4728-B099-4CA38D32C31C</RequestId>
    <ページ番号> 1 </ PAGENUMBER>
    <Items>
        <メタ>
            <サイズ> 64</サイズ>
            <データベース> testdb1</Database>
            <テーブル> test1</テーブル>
        </メタ>
    </Items>
    <DBInstanceName>rm-uf6wjk5xxxxxxx</DBInstanceName>
</DescribeMetaList>

JSON 形式

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

{
  "TotalPageCount" : "1" 、
  "TotalRecordCount" : "1" 、
  "PageRecordCount" : "1" 、
  "RequestId" : "60F9A12A-16B8-4728-B099-4CA38D32C31C" 、
  "PageNumber" : "1" 、
  "アイテム" : {
    "メタ" : [ {
      "サイズ" : "64" 、
      "データベース" : "testdb1" 、
      "テーブル" : "test1"
    } ]
  },
  "DBInstanceName" : "rm-uf6wjk5xxxxxxx"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
400 InvalidPageSize ページサイズが無効です pageSizeパラメーターの値が無効な場合に返されるエラーメッセージ。 有効な番号を入力してください。
400 InvalidRestoreTime. フォーマット 指定された復元時間は無効です。 指定された復元時間が無効な場合に返されるエラーメッセージ。 有効時間を入力します。
403 InvalidMeta.Empty メタ情報は空です。 メタ情報がnullの場合に返されるエラーメッセージ。
403 IncorrectDBInstanceType 現在のDBインスタンスタイプは、この操作をサポートしていません。 インスタンスが現在の状態の場合、この操作がサポートされていない場合に返されるエラーメッセージ。
403 IncorrectEngineVersion 現在のエンジンバージョンは操作をサポートしていません。 インスタンスで実行されているデータベースエンジンバージョンでは、この操作がサポートされていない場合に返されるエラーメッセージ。
403 InvalidBackupLogStatus 現在のバックアップログ有効ステータスは、この操作をサポートしていません。 ログバックアップ機能が無効になっており、データを特定の時点に復元できない場合に返されるエラーメッセージ。
404 InvalidBackupSetID.NotFound 指定されたバックアップセットIDが存在しません。 指定されたデータバックアップファイルが見つからない場合に返されるエラーメッセージ。 既存のデータバックアップファイルを確認します。

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