ModifyBackupPolicy - - Alibaba Cloud ドキュメントセンター

この操作を呼び出して、PolarDB クラスターの自動バックアップポリシーを変更できます。

操作説明

説明

コンソールで PolarDB クラスターの自動バックアップポリシーを変更することもできます。詳細については、「バックアップ設定」をご参照ください。

今すぐお試しください

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

update

*dbcluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。説明 DescribeDBClusters 操作を呼び出して、クラスター ID を含む、特定のリージョン内のすべてのクラスターに関する情報をクエリできます。	pc-bp13wz9586voc****
PreferredBackupTime	string	任意	自動バックアップを実行するタイムウィンドウ。時間は `hh:mmZ-hh:mmZ` 形式の UTC で指定します。タイムウィンドウは 1 時間で、正時に開始する必要があります。例: `14:00Z-15:00Z`。	15:00Z-16:00Z
PreferredBackupPeriod	string	任意	バックアップサイクル。有効な値: Monday Tuesday Wednesday Thursday Friday Saturday Sunday 説明少なくとも 2 日を選択します。複数の値はカンマ (,) で区切ります。 PolarDB for MySQL クラスターが配置されているリージョンがリージョン間バックアップ機能をサポートしている場合、このパラメーターはサポートされません。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。高度なバックアップ機能を有効にすると、このパラメーターは無効になります。代わりに AdvancedDataPolicies パラメーターを使用してください。	Monday,Tuesday
DataLevel1BackupRetentionPeriod	string	任意	レベル 1 バックアップの保持期間。有効な値: 3～14。単位: 日。説明高度なバックアップ機能を有効にすると、このパラメーターは無効になります。代わりに AdvancedDataPolicies パラメーターを使用してください。	3
DataLevel2BackupRetentionPeriod	string	任意	レベル 2 バックアップの保持期間。有効な値: 0: レベル 2 バックアップ機能を無効にします。 30～7300: レベル 2 バックアップの保持期間 (日数)。 -1: レベル 2 バックアップは永続的に保持されます。説明クラスターを作成するときのデフォルト値は 0 で、レベル 2 バックアップ機能は無効になります。高度なバックアップ機能を有効にすると、このパラメーターは無効になります。代わりに AdvancedDataPolicies パラメーターを使用してください。	0
BackupRetentionPolicyOnClusterDeletion	string	任意	クラスターを削除するときにバックアップを保持するかどうかを指定します。 ALL: すべてのバックアップを永続的に保持します。 LATEST: 最後のバックアップを永続的に保持します。 NONE: バックアップセットを保持しません。説明デフォルト値は NONE です。	NONE
BackupFrequency	string	任意	バックアップ周波数。有効な値: Normal (デフォルト): 標準バックアップ。システムはクラスターを 1 日に 1 回バックアップします。 2/24H: 高周波バックアップ。システムはクラスターを 2 時間ごとにバックアップします。 3/24H: 高周波バックアップ。システムはクラスターを 3 時間ごとにバックアップします。 4/24H: 高周波バックアップ。システムはクラスターを 4 時間ごとにバックアップします。説明高周波バックアップを有効にすると、24 時間以内に完了したすべてのバックアップが保持されます。24 時間以上経過したバックアップについては、システムは毎日 00:00 以降に完了した最初のバックアップのみを保持します。その他のバックアップは削除されます。高周波バックアップを有効にすると、PreferredBackupPeriod パラメーターは自動的に週のすべての日 (月曜日から日曜日) に設定されます。 PolarDB for MySQL クラスターが配置されているリージョンがリージョン間バックアップ機能をサポートしている場合、このパラメーターはサポートされません。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。高度なバックアップ機能を有効にすると、このパラメーターは無効になります。代わりに AdvancedDataPolicies パラメーターを使用してください。	Normal
DataLevel1BackupFrequency	string	任意	バックアップ周波数。有効な値: Normal (デフォルト): 標準バックアップ。システムはクラスターを 1 日に 1 回バックアップします。 2/24H: 高周波バックアップ。システムはクラスターを 2 時間ごとにバックアップします。 3/24H: 高周波バックアップ。システムはクラスターを 3 時間ごとにバックアップします。 4/24H: 高周波バックアップ。システムはクラスターを 4 時間ごとにバックアップします。説明このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。 PolarDB for MySQL クラスターが配置されているリージョンがリージョン間バックアップ機能をサポートしている場合、このパラメーターはサポートされません。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。高度なバックアップ機能を有効にすると、このパラメーターは無効になります。代わりに AdvancedDataPolicies パラメーターを使用してください。	Normal
DataLevel1BackupTime	string	任意	自動バックアップを実行するタイムウィンドウ。時間は `hh:mmZ-hh:mmZ` 形式の UTC で指定します。タイムウィンドウは 1 時間で、正時に開始する必要があります。例: `14:00Z-15:00Z`。説明このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。 PolarDB for MySQL クラスターが配置されているリージョンがリージョン間バックアップ機能をサポートしている場合、このパラメーターはサポートされません。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。	15:00Z-16:00Z
DataLevel1BackupPeriod	string	任意	レベル 1 バックアップサイクル。有効な値: Monday Tuesday Wednesday Thursday Friday Saturday Sunday 説明少なくとも 2 日を選択します。複数の値はカンマ (,) で区切ります。このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。 PolarDB for MySQL クラスターが配置されているリージョンがリージョン間バックアップ機能をサポートしている場合、このパラメーターはサポートされません。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。高度なバックアップ機能を有効にすると、このパラメーターは無効になります。代わりに AdvancedDataPolicies パラメーターを使用してください。	Monday,Tuesday
DataLevel2BackupPeriod	string	任意	レベル 2 バックアップサイクル。有効な値: Monday Tuesday Wednesday Thursday Friday Saturday Sunday 説明少なくとも 2 日を選択します。複数の値はカンマ (,) で区切ります。このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。 PolarDB for MySQL クラスターが配置されているリージョンがリージョン間バックアップ機能をサポートしている場合、このパラメーターはサポートされません。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。高度なバックアップ機能を有効にすると、このパラメーターは無効になります。代わりに AdvancedDataPolicies パラメーターを使用してください。	Monday,Tuesday
DataLevel2BackupAnotherRegionRegion	string	任意	リージョン間レベル 2 バックアップのターゲットリージョン。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。説明高度なバックアップ機能を有効にすると、このパラメーターは無効になります。代わりに AdvancedDataPolicies パラメーターを使用してください。	cn-hangzhou
DataLevel2BackupAnotherRegionRetentionPeriod	string	任意	リージョン間レベル 2 バックアップの保持期間。有効な値: 0: リージョン間レベル 2 バックアップ機能を無効にします。 30～7300: リージョン間レベル 2 バックアップの保持期間 (日数)。 -1: リージョン間レベル 2 バックアップは永続的に保持されます。説明クラスターを作成するときのデフォルト値は 0 で、リージョン間レベル 2 バックアップ機能は無効になります。高度なバックアップ機能を有効にすると、このパラメーターは無効になります。代わりに AdvancedDataPolicies パラメーターを使用してください。	30
BackupPolicyLevel	string	任意	バックアップポリシーのレベル。有効な値: Normal: 標準バックアップ Advanced: 高度なバックアップ説明このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。 DescribeBackupPolicy 操作の応答にある `AdvancedPolicyOption` パラメーターを確認して、クラスターが高度なバックアップをサポートしているかどうかを判断します。クラスターが高度なバックアップをサポートしている場合は、「高度なバックアップ設定」でこの機能をリクエストしてください。高度なバックアップを有効にした後、標準バックアップに切り替えることはできません。	Normal
AdvancedDataPolicies	array<object>	任意	高度なバックアップポリシー。説明このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) および PolarDB for PostgreSQL ではサポートされていません。このパラメーターは、`BackupPolicyLevel` が `Advanced` に設定されているクラスターでのみサポートされます。
	object	任意
ActionType	string	任意	操作タイプ。有効な値: CREATE: 作成 UPDATE: 更新 DELETE: 削除	CREATE
OnlyPreserveOneEachHour	boolean	任意	1 時間ごとのバックアップの保持ポリシー。有効な値: true: 1 時間以上経過したバックアップについて、各時間の最も古いバックアップセットのみを保持します。 false: すべてのバックアップセットを保持します。説明このパラメーターは変更できません。値は `true` に固定されています。	true
RetentionValue	string	任意	バックアップを保持する日数。	7
BakType	string	任意	バックアップタイプ。有効な値: F: フルバックアップ説明このパラメーターは変更できません。値は `F` に固定されています。	F
FilterKey	string	任意	スケジューリングタイプ。有効な値: dayOfWeek: 週次スケジュール dayOfMonth: 月次スケジュール dayOfYear: 年次スケジュール backupInterval: 固定間隔スケジュール説明このパラメーターは、`FilterType` が crontab に設定されている場合にのみ必要です。	dayOfWeek
FilterValue	string	任意	バックアップサイクル。	1,2,3,4,5,6,7
DestType	string	任意	バックアップポリシーの宛先タイプ。有効な値: level1: レベル 1 バックアップ level2: レベル 2 バックアップ level2Cross: リージョン間レベル 2 バックアップ	level2
FilterType	string	任意	高度なポリシーのフィルタータイプ。有効な値: crontab: 定期的なスケジュール event: イベントベースのスケジュール	crontab
SrcRegion	string	任意	バックアップポリシーのソースリージョン。	cn-shanghai
AutoCreated	boolean	任意	バックアップポリシーがシステムによって自動的に生成されたかどうかを示します。説明このパラメーターは自動的に生成されます。このパラメーターは指定しないでください。	false
SrcType	string	任意	バックアップポリシーのソースタイプ。有効な値: db: データベースクラスター level1: レベル 1 バックアップ level2: レベル 2 バックアップ level2Cross: リージョン間レベル 2 バックアップ	level1
OnlyPreserveOneEachDay	boolean	任意	24 時間以上経過したバックアップの保持ポリシー。 true: 24 時間以上経過したバックアップについて、その日の最初のバックアップセットのみを保持します。 false: すべてのバックアップを保持します。	true
DumpAction	string	任意	レベル 1 バックアップをレベル 2 バックアップに変換するメソッド。有効な値: copy: コピー	copy
PolicyId	string	任意	バックアップポリシーの ID。DescribeBackupPolicy 操作を呼び出して ID を表示します。	71930ac2e9f15e41615e10627c******
DestRegion	string	任意	バックアップポリシーのターゲットリージョン。	cn-beijing
RetentionType	string	任意	バックアップセットの保持期間のタイプ。有効な値: never: 有効期限なし delay: 指定した日数後に有効期限が切れます。	delay

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	C5A5DF0E-5968-4DC1-882E-AC2FE7******

例

成功レスポンス

JSONJSON

{
  "RequestId": "C5A5DF0E-5968-4DC1-882E-AC2FE7******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidDataLevel1BackupRetentionPeriod.Malformed	The specified parameter DataLevel1BackupRetentionPeriod is not valid.
400	InvalidDataLevel2BackupRetentionPeriod.Malformed	The specified parameter DataLevel2BackupRetentionPeriod is not valid.
400	InvalidBackupRetentionPeriod.Malformed	The specified parameter BackupRetentionPeriod is not valid.
400	InvalidBackupFrequency.Malformed	The specified parameter BackupFrequency is not valid.
400	InvalidPreferredBackupPeriod.Malformed	The specified parameter PreferredBackupPeriod is not valid.
400	InvalidDataLevel2BackupPeriod.Malformed	The specified parameter DataLevel2BackupPeriod is not valid.
400	InvalidDataLevel1BackupPeriod.Malformed	The specified parameter DataLevel1BackupPeriod is not valid.
400	InvalidPreferredBackupTime.Malformed	The specified parameter PreferredBackupTime is not valid.
400	InvalidDataLevel1BackupTime.Malformed	The specified parameter DataLevel1BackupTime is not valid.
400	InvalidDataLevel1BackupFrequency.Malformed	The specified parameter DataLevel1BackupFrequency is not valid.
400	InvalidDataLevel2AnotherRegionRegion.NotFound	The specified parameter DataLevel2BackupAnotherRegionRegion does not found.
400	InvalidDataLevel2AnotherRegionBackupRetentionPeriod.Malformed	The specified parameter DataLevel2BackupAnotherRegionRetentionPeriod is not valid.
403	IncorrectBackupPolicy	Current DB type does not support low frequency backupPolicy operation.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidParam	new archiveBackup policy already exists. dumpretention parameter cannot used alone
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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

変更履歴

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