DescribeBackups を使用してバックアップセットをクエリする - ClickHouse

指定された ApsaraDB for ClickHouse クラスターのバックアップセットを照会します。

操作説明

説明

データバックアップ機能は、バージョン 21.8 以降を実行している ApsaraDB for ClickHouse クラスターでのみ使用できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

clickhouse:DescribeBackups

get

*DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID です。	cc-bp1qx68m06981****
BackupId	string	任意	データバックアップタスク ID です。	117403****
StartTime	string	必須	クエリする時間範囲の開始時刻。時間は yyyy-MM-ddTHH:mmZ 形式で指定し、UTC である必要があります。	2021-11-21T16:00Z
EndTime	string	必須	クエリする時間範囲の終了時刻。時間は yyyy-MM-ddTHH:mmZ 形式で指定し、UTC である必要があります。	2021-11-25T16:00Z
PageSize	integer	任意	1 ページあたりのエントリ数。有効値: 30 (デフォルト) 50 100	30
PageNumber	integer	任意	ページ番号です。	1

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	string	エントリの総数です。	1
PageSize	string	1 ページあたりのエントリ数。有効値: 30 (デフォルト) 50 100	30
RequestId	string	リクエスト ID です。	F5178C10-1407-4987-9133-DE4DC9119F75
PageNumber	string	ページ番号です。	1
Items	array<object>	バックアップセットのリストです。
	object
DBClusterId	string	クラスター ID です。	cc-bp1qx68m06981****
BackupStatus	string	バックアップステータス。有効値: Success: バックアップは成功です。 Failure: バックアップは失敗しました。	Success
BackupType	string	バックアップタイプ。有効値: FullBackup: 完全バックアップ。 IncrementalBackup: 増分バックアップ。	IncrementalBackup
BackupStartTime	string	バックアップの開始時刻。時間は yyyy-MM-ddTHH:mmZ 形式で、UTC で表示されます。	2021-11-22T18:28:22Z
BackupSize	integer	バックアップサイズ。単位: MB。	131072
BackupEndTime	string	バックアップの終了時刻。時間は yyyy-MM-ddTHH:mmZ 形式で、UTC で表示されます。	2021-11-22T18:28:41Z
BackupSetInfo	string	クラスターノードの数。単一レプリカ版クラスターの場合、値は 1 から 48 までの整数です。ダブルレプリカ版クラスターの場合、値は 1 から 24 までの整数です。	{"shard_count": 4}
BackupId	string	データバックアップタスク ID です。	117403****
BackupMethod	string	バックアップメソッド。値は常に Physical で、物理バックアップを示します。	Physical
ExpireDate	string	バックアップセットの有効期限。時間は yyyy-MM-ddTHH:mmZ 形式で、UTC で表示されます。	2022-07-22T18:28:41Z

例

成功レスポンス

JSONJSON

{
  "TotalCount": "1",
  "PageSize": "30",
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": "1",
  "Items": [
    {
      "DBClusterId": "cc-bp1qx68m06981****",
      "BackupStatus": "Success",
      "BackupType": "IncrementalBackup",
      "BackupStartTime": "2021-11-22T18:28:22Z",
      "BackupSize": 131072,
      "BackupEndTime": "2021-11-22T18:28:41Z",
      "BackupSetInfo": "{\"shard_count\": 4}",
      "BackupId": "117403****",
      "BackupMethod": "Physical",
      "ExpireDate": "2022-07-22T18:28:41Z"
    }
  ]
}

エラーコード

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

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

変更履歴

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