DescribeBackups API を呼び出してバックアップリストを取得する - AnalyticDB

AnalyticDB for MySQL クラスターのバックアップセットを一覧表示します。

今すぐお試しください

この 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

DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	AnalyticDB for MySQL クラスターの ID です。説明リージョン内のクラスター ID を一覧表示するには、「DescribeDBClusters」を呼び出します。	am-bp18934i73vb5****
BackupId	string	任意	バックアップセットの ID です。	32732****
StartTime	string	任意	クエリの開始時刻です。フォーマット：yyyy-MM-ddTHH:mmZ。	2022-06-01T16:00Z
EndTime	string	任意	クエリの終了時刻です。開始時刻より後の時刻を指定する必要があります。フォーマット：yyyy-MM-ddTHH:mmZ。	2022-06-02T16:00Z
PageSize	integer	任意	1 ページあたりの表示件数です。有効な値は以下のとおりです。 30（デフォルト） 50 100	30
PageNumber	integer	任意	ページ番号です。有効な値は、0 より大きい正の整数で、整数型の最大値を超えない値です。デフォルト値は 1 です。	1
CrossUid	string	任意	バックアップセットの所有者の Alibaba Cloud アカウント ID です。説明 Alibaba Cloud アカウント間でのバックアップを行う場合にのみ、このパラメーターを指定します。	195****
CrossRole	string	任意	バックアップセットの所有者の Alibaba Cloud アカウントにおける RAM ロール名です。説明 Alibaba Cloud アカウント間でのバックアップを行う場合にのみ、このパラメーターを指定します。	role-for-xxx
RegionId	string	任意	リージョン ID です。説明 AnalyticDB for MySQL でサポートされるリージョンおよびゾーン（リージョン ID を含む）の一覧を表示するには、「DescribeRegions」を呼び出します。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	バックアップセットのリストです。
TotalCount	string	バックアップセットの合計件数です。	300
PageSize	string	現在のページに表示されるバックアップセットの件数です。	30
RequestId	string	リクエスト ID です。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumber	string	ページ番号です。	1
FreeBackupSize	integer	無料バックアップ容量（バイト単位）です。	0
TotalBackupSize	integer	バックアップ総容量（バイト単位）です。	64953700
Items	object
Backup	array<object>	バックアップセットのリストです。
	object	バックアップセットの詳細情報です。
DBClusterId	string	AnalyticDB for MySQL クラスターの ID です。	am-bp18934i73vb5****
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
BackupStatus	string	バックアップのステータスです。有効な値は以下のとおりです。 Running：バックアップ実行中 Finished：バックアップ完了	Finished

例

成功レスポンス

JSONJSON

{
  "TotalCount": "300",
  "PageSize": "30",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": "1",
  "FreeBackupSize": 0,
  "TotalBackupSize": 64953700,
  "Items": {
    "Backup": [
      {
        "DBClusterId": "am-bp18934i73vb5****",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-06-01T16:00Z",
        "BackupSize": 2167808,
        "BackupEndTime": "2022-06-02T16:00Z",
        "BackupExpiredTime": "2022-07-02T16:00Z",
        "BackupId": "32732****",
        "BackupMethod": "Snapshot",
        "BackupStatus": "Finished"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	CrossUser.CheckFailed	The input UID and role is not authorized.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

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

変更履歴

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