ModifyBackupPolicy操作を呼び出して、インスタンスのバックアップ設定を変更できます。

この API を呼び出す場合、インスタンスは次の要件を満たしている必要があります。

  • インスタンスは読み取り専用インスタンスではありません。
  • インスタンスのステータスは [実行中] です。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須/任意 例: 説明 
操作 String 必須 ModifyBackupPolicy

実行する操作です。 値をModifyBackupPolicyに設定します。

DBInstanceId String 必須 rm-uf6wjk5xxxxxxx

インスタンスの ID です。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。

BackupPolicyMode String 任意 DataBackupPolicy

実行するバックアップのタイプ。 有効な値:

  • DataBackupPolicy: データバックアップ
  • LogBackupPolicy: ログバックアップ
PreferredBackupTime String 任意 00:00Z-01:00Z

バックアップを実行する時刻。 ISO 8601標準の時刻をHH:mm Z- HH:mm Z形式で指定します。 時間は UTC にする必要があります。

説明
  • BackupPolicyModeパラメーターをDataBackupPolicyに設定する場合は、このパラメーターを指定する必要があります。
  • このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
PreferredBackupPeriod String 任意 Monday

バックアップサイクル 少なくとも2つの曜日を指定し、日付をコンマ (,) で区切ります。 有効な値:

  • 月曜日
  • 火曜日
  • 水曜日
  • 木曜日
  • 金曜日
  • 土曜日
  • 日曜日
説明
  • このパラメーターとBackupIntervalパラメーターを使用して、バックアップポリシーを設定できます。 たとえば、このパラメーターを土曜日の日曜日に設定し、BackupIntervalパラメーターを30に設定した場合、バックアップは毎週土曜日と日曜日に30分ごとに実行されます。
  • BackupPolicyModeパラメーターをDataBackupPolicyに設定する場合は、このパラメーターを指定する必要があります。
  • このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
BackupRetentionPeriod String 任意 7

データバックアップファイルを保持する日数。 有効な値: 7 ~ 730

説明
  • BackupPolicyModeパラメーターをDataBackupPolicyに設定する場合は、このパラメーターを指定する必要があります。
  • このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
BackupLog String 任意 有効にする

ログバックアップ機能を有効にするかどうかを指定します。 有効な値:

  • 有効
  • 無効
説明
  • BackupPolicyModeパラメーターをDataBackupPolicyに設定する場合は、このパラメーターを指定する必要があります。
  • このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
LogBackupRetentionPeriod String 任意 7

ログバックアップファイルを保持する日数。 有効な値: 7 ~ 730 ログバックアップの保持期間は、データバックアップの保持期間より長くすることはできません。

説明
  • ログバックアップ機能を有効にすると、ログバックアップの保持期間を指定できます。 このパラメーターは、MySQLとPostgreSQLを実行するインスタンスでのみサポートされます。
  • このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyまたはLogBackupPolicyに設定した場合に有効になります。
EnableBackupLog String いいえ 1

ログバックアップ機能を有効にするかどうかを指定します。 有効な値:

  • Trueまたは1: ログバックアップ機能が有効になっています。
  • Falseまたは0: ログバックアップ機能は無効です。
説明
  • BackupPolicyModeパラメーターをLogBackupPolicyに設定する場合は、このパラメーターを指定する必要があります。
  • このパラメーターは、BackupPolicyModeパラメーターをLogBackupPolicyに設定した場合にのみ有効になります。
LocalLogRetentionHours String 任意 18

インスタンス上のログバックアップファイルを保持する時間数。 有効値: 0 ~ 168 値0は、ログバックアップファイルがインスタンスに保持されないことを示します。 値168は、以下の式: 7 × 24に基づいて計算される。

説明
  • BackupPolicyModeパラメーターをLogBackupPolicyに設定する場合は、このパラメーターを指定する必要があります。
  • このパラメーターは、BackupPolicyModeパラメーターをLogBackupPolicyに設定した場合にのみ有効になります。
LocalLogRetentionSpace String 任意 30

インスタンス上のログバックアップファイルに許可されている最大ストレージ使用量。 インスタンスのログバックアップファイルのストレージ使用量がこのパラメーターの値を超える場合、ApsaraDB RDSは、ストレージ使用量がこのパラメーターの値を下回るまで、以前のログバックアップファイルを削除します。 有効値: 0〜50 デフォルト値を保持できます。

説明
  • BackupPolicyModeパラメーターをLogBackupPolicyに設定する場合は、このパラメーターを指定する必要があります。
  • このパラメーターは、BackupPolicyModeパラメーターをLogBackupPolicyに設定した場合にのみ有効になります。
HighSpaceUsageProtection String 任意 有効にする

インスタンスのストレージ使用量が80% を超えた場合、またはインスタンスの残りのストレージ量が5 GB未満の場合に、ApsaraDB RDSがインスタンスからログバックアップファイルを強制的に削除するかどうかを指定します。 有効な値: Enable and Disable。 デフォルト値を保持できます。

説明
  • BackupPolicyModeパラメーターをLogBackupPolicyに設定する場合は、このパラメーターを指定する必要があります。
  • このパラメーターは、BackupPolicyModeパラメーターをLogBackupPolicyに設定した場合にのみ有効になります。
LogBackupFrequency String 任意 LogInterval

インスタンスのログをバックアップする頻度。 有効な値:

  • LogIntervalは、ログバックアップが30分ごとに実行されることを指定します。
  • デフォルト値は、データバックアップ頻度と同じです。
説明
  • LogIntervalは、SQL Serverを実行するインスタンスでのみサポートされます。
  • このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
CompressType String 任意 4

バックアップが圧縮される形式。 有効な値:

  • 0: バックアップは圧縮されません。
  • 1: zlibツールを使用してバックアップを圧縮します。tar.gzファイル。
  • 2: zlibツールは、バックアップを並行して圧縮するために使用されます。
  • 4: QuickLZツールは、バックアップをに圧縮するために使用されます。xb.gzファイル。 この圧縮形式は、MySQL 5.6またはMySQL 5.7を実行するインスタンスでのみサポートされます。 この圧縮形式のバックアップを使用して、個々のデータベースとテーブルを復元できます。 詳細については、「ApsaraDB RDS For MySQLインスタンスの個々のデータベースとテーブルの復元」をご参照ください。
  • 8: QuickLZツールは、バックアップをに圧縮するために使用されます。xb.gzファイル。 この圧縮形式は、MySQL 8.0を実行するインスタンスでのみサポートされます。 この圧縮形式のバックアップを使用して、個々のデータベースとテーブルを復元することはできません。
説明 このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
ArchiveBackupRetentionPeriod String 任意 365

アーカイブされたバックアップファイルを保持する日数。 デフォルト値0は、バックアップアーカイブ機能が有効でないことを指定します。 有効な値: 301095

説明 このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
ArchiveBackupKeepPolicy String 任意 ByMonth

アーカイブされたバックアップファイルを保持する時間枠。 指定された保存期間内に保存できるアーカイブ済みバックアップファイルの数は、ArchiveBackupKeepCountパラメーターで指定します。 デフォルト値: 0 有効な値:

  • ByMonth
  • ByWeek
  • KeepAll
説明 このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
ArchiveBackupKeepCount Integer いいえ 1

保持するアーカイブバックアップファイルの数。 既定値:1 有効な値:

  • ArchiveBackupKeepPolicyパラメーターがByMonthに設定されている場合、このパラメーターの有効な値は131です。
  • ArchiveBackupKeepPolicyパラメーターがByWeekに設定されている場合、このパラメーターの有効な値は17です。
説明
  • ArchiveBackupKeepPolicyパラメーターがKeepAllに設定されている場合は、このパラメーターを指定する必要はありません。
  • このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
ReleasedKeepPolicy String 任意 なし

インスタンスがリリースされた場合、ApsaraDB RDSがアーカイブバックアップファイルを保持するポリシー。 デフォルト値 : なし。 有効な値:

  • None: アーカイブされたバックアップファイルは保持されません。
  • 最新: 最新のアーカイブバックアップファイルのみが保持されます。
  • すべて: すべてのアーカイブバックアップファイルが保持されます。
説明 このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
LogBackupLocalRetentionNumber Integer いいえ 60

インスタンスに保持するバイナリログファイルの数。 デフォルト値: 60 有効な値: 6100

説明
  • このパラメーターは、BackupPolicyModeパラメーターをLogBackupPolicyに設定した場合にのみ有効になります。
  • インスタンスがMySQLを実行する場合、このパラメーターを -1に設定できます。 値-1は、インスタンスに無制限の数のバイナリログファイルを保持できることを指定します。
カテゴリー String 任意 スタンダード

1桁の2番目のバックアップ機能を有効にするかどうかを指定します。 この機能により、ApsaraDB RDSは数秒以内にバックアップを完了できます。 有効な値:

  • Flash: 1桁の2番目のバックアップ機能が有効になっています。
  • 標準: 1桁の2番目のバックアップ機能は無効です。
説明 このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
BackupInterval String 任意 30

インスタンスでスナップショットバックアップを実行する頻度。 有効な値:

  • -1: バックアップ頻度が指定されていません。
  • 30: スナップショットバックアップは30分に1回実行されます。
  • 60: スナップショットバックアップは60分に1回実行されます。
  • 120: スナップショットバックアップは120分に1回実行されます。
  • 240: スナップショットバックアップは240分に1回実行されます。
  • 480: スナップショットバックアップは480分に1回実行されます。
説明
  • このパラメーターとPreferredBackupPeriodパラメーターを使用して、バックアップポリシーを設定できます。 たとえば、PreferredBackupPeriodパラメーターを土曜日、日曜日に設定し、BackupIntervalパラメーターを -1に設定した場合、スナップショットバックアップは毎週土曜日と日曜日に実行されます。
  • インスタンスがPostgreSQLを実行している場合、BackupIntervalパラメーターは、インスタンスに標準SSDまたは拡張SSD (ESSD) が搭載されている場合にのみサポートされます。
  • インスタンスがSQL Serverを実行している場合、BackupIntervalパラメーターは、インスタンスのスナップショットバックアップ機能が有効になっている場合にのみサポートされます。 詳細については、「ApsaraDB RDS For SQL Serverインスタンスのスナップショットバックアップの有効化」をご参照ください。
  • [Category] パラメーターを [Flash] に設定した場合、BackupIntervalパラメーターは無効です。
  • このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
BackupMethod String 任意 Physical

インスタンスのバックアップ方式。 有効な値:

  • Physical: 物理バックアップ
  • Snapshot: スナップショットバックアップ

デフォルト値: Physical

説明
  • このパラメーターは、標準SSDまたはESSDでSQL Serverを実行するインスタンスでのみ有効です。
  • このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
EnableIncrementDataBackup Boolean いいえ false

増分バックアップ機能を有効にするかどうかを指定します。 有効な値:

  • false: 増分バックアップ機能は無効です。 デフォルト値はfalseです。
  • true: 増分バックアップ機能が有効になっています。
説明
  • このパラメーターは、標準SSDまたはESSDでSQL Serverを実行するインスタンスでのみ有効です。
  • このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。

レスポンスパラメーター

項目 データ型 例: 説明 
RequestId String DA147739-AEAD-4417-9089-65E9B1D8240D

リクエストの ID です。

CompressType String 4

バックアップが圧縮される形式。 有効な値:

  • 0: バックアップは圧縮されません。
  • 1: バックアップはzlibツールを使用して圧縮されます。
  • 2: バックアップはzlibツールを使用して並列に圧縮されます。
  • 4: バックアップはQuickLZツールを使用して圧縮され、個々のデータベースとテーブルを復元するために使用できます。
  • 8: バックアップはQuickLZツールを使用して圧縮されますが、個々のデータベースやテーブルの復元には使用できません。 この値は、MySQL 8.0を実行するインスタンスでのみサポートされます。
LocalLogRetentionSpace String 30

インスタンス上のログバックアップファイルに許可されている最大ストレージ使用量。

LogBackupLocalRetentionNumber Integer 60

インスタンスに保持されているバイナリログファイルの数。

DBInstanceID String rm-uf6wjk5xxxxxxx

インスタンスの ID です。

EnableBackupLog String 1

ログバックアップ機能が有効かどうかを示します。 有効な値:

  • 1: ログバックアップ機能が有効になっています。
  • 0: ログバックアップ機能は無効です。
LocalLogRetentionHours Integer 18

ログバックアップファイルがインスタンスに保持されている時間数。

HighSpaceUsageProtection String 無効にする

インスタンスのストレージ使用量が80% を超えた場合、またはインスタンスの残りのストレージ量が5 GB未満の場合に、ApsaraDB RDSがインスタンスからログバックアップファイルを強制的に削除するかどうかを示します。

リクエストの例

http(s):// rds.aliyuncs.com/?Action=ModifyBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyBackupPolicyResponse>
      <HighSpaceUsageProtection> 無効化 </HighSpaceUsageProtection>
<DBInstanceID>rm-bp1z3xxxxx</DBInstanceID>
<RequestId>E4BF5598-ED12-4406-AAA4-F375428BE741</RequestId>
<LocalLogRetentionHours>18</LocalLogRetentionHours>
<EnableBackupLog>1</EnableBackupLog>
<LocalLogRetentionSpace>30</LocalLogRetentionSpace>
    <LogBackupLocalRetentionNumber>60</LogBackupLocalRetentionNumber>
</ModifyBackupPolicyResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HighSpaceUsageProtection" : "無効" 、
  "DBInstanceID" : "rm-bp1z3xxxxx" 、
  "RequestId" : "E4BF5598-ED12-4406-AAA4-F375428BE741" 、
  "LocalLogRetentionHours" : "18" 、
  "EnableBackupLog" : "1" 、
  "LocalLogRetentionSpace" : "30" 、
  "LogBackupLocalRetentionNumber" : 60
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明 
400 InvalidLogBackupFrequency.Malformed ログバックアップの頻度が無効です。 LogBackupFrequencyパラメーターの値が無効な場合に返されるエラーメッセージ。 パラメーター設定が正しいかどうかを確認します。
400 InvalidBackupRetentionPeriod.Malformed 指定されたバックアップ保持期間は無効です。 バックアップ保持期間が指定されていない場合に返されるエラーメッセージ。 バックアップの保持期間を指定します。 バックアップの保持期間は、1日より短くすることも、30日より長くすることもできません。
400 BackupPropertyNotFound バックアップポリシーが見つかりません バックアップポリシーが見つからない場合に返されるエラーメッセージ。
400 OperationDenied.SwitchToSnapshot スナップショットバックアップは現在、クロスリージョンストレージをサポートしていません。 スナップショットバックアップモードに切り替える前に、クロスリージョンバックアップをオフにしてください。 インスタンスが存在するリージョンとは異なるリージョンにスナップショットバックアップファイルを保存できない場合に返されるエラーメッセージ。 スナップショットバックアップ機能を有効にする前に、クロスリージョンバックアップ機能を無効にする必要があります。
403 IncorrectCategory 現在のインスタンスタイプはカテゴリをサポートしていません。 Categoryパラメーターが現在のインスタンスタイプでサポートされていない場合に返されるエラーメッセージ。
403 OperationDenied.SwitchSnapshotToPhysical スナップショットバックアップへの物理バックアップのみがサポートされています。 操作が物理バックアップ方式からスナップショットバックアップ方式への変更のみをサポートしている場合に返されるエラーメッセージ。
403 OperationDenied.ModifyBackupSwitchOff スイッチがオンになっていません。 バックアップモードの変更は禁止されています。 クロスリージョンバックアップ機能が有効になっていない場合に返されるエラーメッセージ。
403 OperationDenied.ApiForbiddenForLogBackupFrequency インスタンスがスナップショットバックアップの場合、ログバックアップ頻度をデータバックアップと一致させることはできません。 スナップショットバックアップ機能が有効になっている場合、ログバックアップ頻度がデータバックアップ頻度と同じにならない場合に返されるエラーメッセージ。
403 OperationDenied.NotSupportedBackupMethod ストレージが4000 GBを超える場合、スナップショットバックアップのみがサポートされます。 ストレージが4,000 GBを超える場合、インスタンスがスナップショットバックアップのみをサポートしている場合に返されるエラーメッセージ。
403 OperationDenied.ApiForbidden 操作は許可されていません。 操作が許可されていない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。