DescribeDetachedBackups を使用して分離バックアップをクエリ - PolarDB - Alibaba Cloud - PolarDB

削除済み PolarDB クラスターのバックアップセットの詳細を照会します。

操作説明

この操作を呼び出す場合、PolarDB クラスターは 削除済み ステータスである必要があり、クラスターの削除時に次のバックアップ保持オプションのいずれかが選択されている必要があります。すべてのバックアップの Long-term Retention (LTR) または 最後のバックアップ (削除前の自動バックアップ) の Long-term Retention (LTR)。削除済みクラスターの保持されているすべてのバックアップセットが手動で削除されている場合、この操作ではクラスターを照会できなくなります。

説明

DescribeDBClusterAttribute 操作を呼び出して、クラスターのステータスを照会できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeDetachedBackups

get

*クラスター

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID。	pc-****************
BackupId	string	任意	バックアップの ID。	111111111
BackupStatus	string	任意	バックアップのステータス。有効な値: Success: バックアップが完了しています。 Failed: バックアップが失敗しています。	Success
BackupMode	string	任意	バックアップモード。有効な値: Automated: 自動バックアップ。 Manual: 手動バックアップ。	Manual
BackupRegion	string	任意	クロスリージョンバックアップのターゲットリージョン。説明このパラメーターは PolarDB for MySQL でのみサポートされています。	cn-hangzhou
StartTime	string	必須	クエリする時間範囲の開始時刻。時刻は `YYYY-MM-DDThh:mmZ` フォーマット (協定世界時 (UTC)) で指定します。	2020-05-01T00:00Z
EndTime	string	必須	クエリする時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時刻は `YYYY-MM-DDThh:mmZ` フォーマット (協定世界時 (UTC)) で指定します。	2020-05-14T00:00Z
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値: 30 50 100 デフォルト値: 30。	30
PageNumber	integer	任意	ページ番号。値は、Integer データ型の最大値を超えない正の整数である必要があります。デフォルト値: 1。	1

レスポンスフィールド

フィールド	型	説明	例
	object
Items	object
Backup	array<object>	バックアップセットの詳細。
	object
BackupEndTime	string	バックアップの終了時刻 (協定世界時 (UTC))。	2020-05-12T03:25:55Z
BackupId	string	バックアップの ID。	111111111
BackupMethod	string	データバックアップのメソッド。スナップショットバックアップのみがサポートされています。値は Snapshot に固定されています。	Snapshot
BackupMode	string	バックアップモード。有効な値: Automated: 自動バックアップ。 Manual: 手動バックアップ。	Manual
BackupSetSize	string	バックアップファイルのサイズ。単位: バイト。説明スナップショットはデータブロックを共有するため、スナップショットバックアップを削除した後に解放されるスペースは、バックアップファイルのサイズよりもはるかに小さくなります。	7251056
BackupStartTime	string	バックアップの開始時刻 (協定世界時 (UTC))。	2020-05-12T03:25:44Z
BackupStatus	string	バックアップのステータス。有効な値: Success: バックアップが完了しています。 Failed: バックアップが失敗しています。	Success
BackupType	string	バックアップタイプ。完全バックアップのみがサポートされています。値は FullBackup に固定されています。	FullBackup
BackupsLevel	string	バックアップセットのレベル。有効な値: Level-1: レベル 1 バックアップ。 Level-2: レベル 2 バックアップ。	Level-2
ConsistentTime	string	整合性スナップショットのポイント。値は UNIX タイムスタンプです。単位: 秒。	1589253947
DBClusterId	string	クラスターの ID。	pc-**************
IsAvail	string	バックアップセットが利用可能かどうかを示します。有効な値: 0: 利用不可。 1: 利用可能。	1
StoreStatus	string	バックアップセットを削除できるかどうかを示します。有効な値: Enabled: バックアップセットを削除できます。 Disabled: バックアップセットを削除できません。	Disabled
PageNumber	string	ページ番号。	1
PageRecordCount	string	現在のページのエントリ数。	15
RequestId	string	リクエストの ID。	717B2382-BB14-4DCB-BBC2-32DBE0******
TotalRecordCount	string	エントリの総数。	50

例

成功レスポンス

JSONJSON

{
  "Items": {
    "Backup": [
      {
        "BackupEndTime": "2020-05-12T03:25:55Z",
        "BackupId": "111111111",
        "BackupMethod": "Snapshot",
        "BackupMode": "Manual",
        "BackupSetSize": "7251056",
        "BackupStartTime": "2020-05-12T03:25:44Z",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupsLevel": "Level-2",
        "ConsistentTime": "1589253947",
        "DBClusterId": "pc-**************",
        "IsAvail": "1",
        "StoreStatus": "Disabled"
      }
    ]
  },
  "PageNumber": "1",
  "PageRecordCount": "15",
  "RequestId": "717B2382-BB14-4DCB-BBC2-32DBE0******",
  "TotalRecordCount": "50"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidBackupStatus.Malformed	The specified parameter BackupStatus is not valid.	指定された BackupStatus パラメーターが無効です。
400	InvalidBackupMode.Malformed	The specified parameter BackupMode is not valid.	指定された BackupMode パラメーターが無効です。
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.	指定された StartTime パラメーターが無効です。
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.	指定されたパラメーター EndTime が無効です。
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	指定されたパラメーター PageSize が無効です。
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	指定されたパラメーター PageNumber が無効です。
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	指定されたクラスターインスタンス ID が存在しないため、操作は失敗しました。
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定された DBClusterId がレコードに存在しません。
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	指定された DBClusterId が現在のレコードに存在しません。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。