DescribeBackups を使用したバックアップセットのクエリ - AnalyticDB

インスタンスのバックアップセットをクエリします。

操作説明

このサービスのエンドポイントの詳細については、「エンドポイント」をご参照ください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:DescribeBackups

get

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	Data Lakehouse Edition クラスターの ID。説明特定のリージョン内のすべてのクラスターの ID をクエリするには、DescribeDBClusters 操作を呼び出します。	am-bp18934i73vb5****
BackupId	string	任意	バックアップセット ID。	1679758862
StartTime	string	必須	クエリする時間範囲の開始時刻。時間は `yyyy-MM-ddTHH:mmZ` 形式で指定します。	2011-06-01T16:00Z
EndTime	string	必須	クエリする時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時間は `yyyy-MM-ddTHH:mmZ` 形式で指定します。	2023-02-20T02:30Z
PageSize	integer	任意	各ページに返すエントリ数。有効な値： 30 50 100 デフォルト値：30。	30
PageNumber	integer	任意	ページ番号。値は、整数データ型の最大値を超えない正の整数である必要があります。デフォルト値：1。	1
Remote	boolean	任意	リージョン間バックアップのみをクエリするかどうかを指定します。値を true に設定するとリージョン間バックアップのみがクエリされ、false に設定するとローカルバックアップのみがクエリされます。	false

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	string	エントリの総数。	300
PageSize	string	現在のページのバックアップセット数。	30
RequestId	string	リクエスト ID。	CE17270B-F8F8-5A31-9DB4-DADDFDAD7940
PageNumber	string	ページ番号。	1
FreeBackupSize	integer	無料のバックアップ容量。単位：バイト。	0
TotalBackupSize	integer	バックアップセットの合計サイズ。単位：バイト。	64953700
Items	object
Backup	array<object>	バックアップセットのリスト。
	object
DBClusterId	string	Data Lakehouse Edition クラスターの ID。	am-bp11q28kvl688****
BackupType	string	バックアップタイプ。有効な値： FullBackup：完全バックアップ。 IncrementalBackup：増分バックアップ。	FullBackup
BackupStartTime	string	バックアップの開始時刻。	2022-06-01T16:00Z
BackupSize	integer	バックアップファイルのサイズ。単位：バイト。	2167808
BackupEndTime	string	バックアップの終了時刻。	2022-06-02T16:00Z
BackupExpiredTime	string	バックアップセットの有効期限。	2022-07-02T16:00Z
BackupId	string	バックアップセット ID。	32732****
BackupMethod	string	バックアップ方法。サポートされているのはスナップショットバックアップのみです。	Snapshot
BackupRegion	string	リージョン間バックアップが保存されているリージョン。	cn-hangzhou
ParentBackupId	string	リージョン間バックアップに関連付けられているローカルバックアップセットの ID。	32733****
BackupStatus	string	バックアップステータス。有効な値： Running：バックアップが進行中です。 Finished：バックアップが完了しました。	Finished

例

成功レスポンス

JSONJSON

{
  "TotalCount": "300",
  "PageSize": "30",
  "RequestId": "CE17270B-F8F8-5A31-9DB4-DADDFDAD7940",
  "PageNumber": "1",
  "FreeBackupSize": 0,
  "TotalBackupSize": 64953700,
  "Items": {
    "Backup": [
      {
        "DBClusterId": "am-bp11q28kvl688****",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-06-01T16:00Z",
        "BackupSize": 2167808,
        "BackupEndTime": "2022-06-02T16:00Z",
        "BackupExpiredTime": "2022-07-02T16:00Z\n",
        "BackupId": "32732****",
        "BackupMethod": "Snapshot",
        "BackupRegion": "cn-hangzhou",
        "ParentBackupId": "32733****",
        "BackupStatus": "Finished"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

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

変更履歴

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