DescribeBackupPolicy を使用してバックアップ設定をクエリする - 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:DescribeBackupPolicy

get

DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID。	am-bp1xxxxxxxx47

レスポンスフィールド

フィールド	型	説明	例
	object
PreferredBackupPeriod	string	バックアップが実行される周期。複数の曜日が指定されている場合、曜日はコンマ (,) で区切られます。有効な値： Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Tuesday,Friday
LogBackupRetentionPeriod	integer	ログバックアップファイルが保持される日数。	7
RequestId	string	リクエストの ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
PreferredBackupTime	string	バックアップ時間。HH:mmZ-HH:mmZ 形式で時間を指定します。	15:00Z-16:00Z
EnableBackupLog	string	back-to-origin プロトコルを有効にするかどうかを指定します。 true：有効 false：無効	true
BackupRetentionPeriod	integer	データバックアップファイルが保持される日数。	7

例

成功レスポンス

JSONJSON

{
  "PreferredBackupPeriod": "Tuesday,Friday",
  "LogBackupRetentionPeriod": 7,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "EnableBackupLog": "true",
  "BackupRetentionPeriod": 7
}

エラーコード

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

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

変更履歴

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