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

リリース済みの PolarDB クラスター内のバックアップセットに関する情報をクエリします。

操作説明

この操作を呼び出す前に、PolarDB クラスターが リリース済み 状態であることを確認してください。また、クラスターをリリースした後に、すべてのバックアップを永続的に保持 または 最後の自動バックアップを永続的に保持 のバックアップ保持ポリシーが有効になっていることを確認する必要があります。クラスターのリリース後にすべてのバックアップセットを削除した場合、この API 操作を使用してクラスターをクエリすることはできません。

説明

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

*dbcluster

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
TotalRecordCount	string	返されたエントリの総数。	50
PageRecordCount	string	1 ページあたりのエントリ数。	15
RequestId	string	リクエストの ID。	717B2382-BB14-4DCB-BBC2-32DBE0******
PageNumber	string	ページ番号。	1
Items	object
Backup	array<object>	バックアップセットの詳細。
	object
BackupSetSize	string	バックアップセットのサイズ。単位：バイト。説明ターゲットのスナップショットバックアップを削除すると、バックアップによって消費されたストレージ領域が解放されます。スナップショットは特定のデータブロックを共有するため、解放されるストレージ領域はバックアップファイルのサイズよりも小さくなります。	7251056
ConsistentTime	string	スナップショットのチェックポイント時間。値は UNIX タイムスタンプです。	1589253947
StoreStatus	string	バックアップセットを削除できるかどうかを示します。有効な値： Enabled：バックアップセットは削除できます。 Disabled：バックアップセットは削除できません。	Disabled
BackupStatus	string	バックアップセットのステータス。有効な値： Success Failed	Success
BackupType	string	バックアップのタイプ。完全バックアップのみがサポートされています。値は FullBackup に設定されます。	FullBackup
BackupStartTime	string	バックアップタスクの開始時刻。時間は UTC で表示されます。	2020-05-12T03:25:44Z
IsAvail	string	バックアップセットが利用可能かどうかを示します。有効な値： 0：データバックアップセットは利用できません。 1：データバックアップセットは利用可能です。	1
BackupEndTime	string	バックアップタスクの終了時刻。時間は UTC で表示されます。	2020-05-12T03:25:55Z
BackupId	string	バックアップセットの ID。	111111111
DBClusterId	string	クラスターの ID。	pc-**************
BackupsLevel	string	バックアップセットのレベル。有効な値： Level-1：レベル 1 バックアップセット Level-2：レベル 2 バックアップセット	Level-2
BackupMode	string	バックアップモード。有効な値： Automated Manual	Manual
BackupMethod	string	バックアップメソッド。スナップショットバックアップのみがサポートされています。値は Snapshot に設定されます。	Snapshot

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidBackupStatus.Malformed	The specified parameter BackupStatus is not valid.
400	InvalidBackupMode.Malformed	The specified parameter BackupMode is not valid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.

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

変更履歴

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