ModifyBackupPolicy操作を呼び出して、インスタンスのバックアップ設定を変更できます。
この API を呼び出す場合、インスタンスは次の要件を満たしている必要があります。
- インスタンスは読み取り専用インスタンスではありません。
- インスタンスのステータスは [実行中] です。
デバッグ
リクエストパラメーター
項目 | データ型 | 必須/任意 | 例: | 説明 |
---|---|---|---|---|
操作 | String | 必須 | ModifyBackupPolicy | 実行する操作です。 値をModifyBackupPolicyに設定します。 |
DBInstanceId | String | 必須 | rm-uf6wjk5xxxxxxx | インスタンスの ID です。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。 |
BackupPolicyMode | String | 任意 | DataBackupPolicy | 実行するバックアップのタイプ。 有効な値:
|
PreferredBackupTime | String | 任意 | 00:00Z-01:00Z | バックアップを実行する時刻。 ISO 8601標準の時刻をHH:mm Z- HH:mm Z形式で指定します。 時間は UTC にする必要があります。 説明
|
PreferredBackupPeriod | String | 任意 | Monday | バックアップサイクル 少なくとも2つの曜日を指定し、日付をコンマ (,) で区切ります。 有効な値:
説明
|
BackupRetentionPeriod | String | 任意 | 7 | データバックアップファイルを保持する日数。 有効な値: 7 ~ 730 説明
|
BackupLog | String | 任意 | 有効にする | ログバックアップ機能を有効にするかどうかを指定します。 有効な値:
説明
|
LogBackupRetentionPeriod | String | 任意 | 7 | ログバックアップファイルを保持する日数。 有効な値: 7 ~ 730 ログバックアップの保持期間は、データバックアップの保持期間より長くすることはできません。 説明
|
EnableBackupLog | String | いいえ | 1 | ログバックアップ機能を有効にするかどうかを指定します。 有効な値:
説明
|
LocalLogRetentionHours | String | 任意 | 18 | インスタンス上のログバックアップファイルを保持する時間数。 有効値: 0 ~ 168 値0は、ログバックアップファイルがインスタンスに保持されないことを示します。 値168は、以下の式: 7 × 24に基づいて計算される。 説明
|
LocalLogRetentionSpace | String | 任意 | 30 | インスタンス上のログバックアップファイルに許可されている最大ストレージ使用量。 インスタンスのログバックアップファイルのストレージ使用量がこのパラメーターの値を超える場合、ApsaraDB RDSは、ストレージ使用量がこのパラメーターの値を下回るまで、以前のログバックアップファイルを削除します。 有効値: 0〜50 デフォルト値を保持できます。 説明
|
HighSpaceUsageProtection | String | 任意 | 有効にする | インスタンスのストレージ使用量が80% を超えた場合、またはインスタンスの残りのストレージ量が5 GB未満の場合に、ApsaraDB RDSがインスタンスからログバックアップファイルを強制的に削除するかどうかを指定します。 有効な値: Enable and Disable。 デフォルト値を保持できます。 説明
|
LogBackupFrequency | String | 任意 | LogInterval | インスタンスのログをバックアップする頻度。 有効な値:
説明
|
CompressType | String | 任意 | 4 | バックアップが圧縮される形式。 有効な値:
説明 このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。 |
ArchiveBackupRetentionPeriod | String | 任意 | 365 | アーカイブされたバックアップファイルを保持する日数。 デフォルト値0は、バックアップアーカイブ機能が有効でないことを指定します。 有効な値: 30〜1095。 説明 このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。 |
ArchiveBackupKeepPolicy | String | 任意 | ByMonth | アーカイブされたバックアップファイルを保持する時間枠。 指定された保存期間内に保存できるアーカイブ済みバックアップファイルの数は、ArchiveBackupKeepCountパラメーターで指定します。 デフォルト値: 0 有効な値:
説明 このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。 |
ArchiveBackupKeepCount | Integer | いいえ | 1 | 保持するアーカイブバックアップファイルの数。 既定値:1 有効な値:
説明
|
ReleasedKeepPolicy | String | 任意 | なし | インスタンスがリリースされた場合、ApsaraDB RDSがアーカイブバックアップファイルを保持するポリシー。 デフォルト値 : なし。 有効な値:
説明 このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。 |
LogBackupLocalRetentionNumber | Integer | いいえ | 60 | インスタンスに保持するバイナリログファイルの数。 デフォルト値: 60 有効な値: 6〜100。 説明
|
カテゴリー | String | 任意 | スタンダード | 1桁の2番目のバックアップ機能を有効にするかどうかを指定します。 この機能により、ApsaraDB RDSは数秒以内にバックアップを完了できます。 有効な値:
説明 このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。 |
BackupInterval | String | 任意 | 30 | インスタンスでスナップショットバックアップを実行する頻度。 有効な値:
説明
|
BackupMethod | String | 任意 | Physical | インスタンスのバックアップ方式。 有効な値:
デフォルト値: Physical。 説明
|
EnableIncrementDataBackup | Boolean | いいえ | false | 増分バックアップ機能を有効にするかどうかを指定します。 有効な値:
説明
|
レスポンスパラメーター
項目 | データ型 | 例: | 説明 |
---|---|---|---|
RequestId | String | DA147739-AEAD-4417-9089-65E9B1D8240D | リクエストの ID です。 |
CompressType | String | 4 | バックアップが圧縮される形式。 有効な値:
|
LocalLogRetentionSpace | String | 30 | インスタンス上のログバックアップファイルに許可されている最大ストレージ使用量。 |
LogBackupLocalRetentionNumber | Integer | 60 | インスタンスに保持されているバイナリログファイルの数。 |
DBInstanceID | String | rm-uf6wjk5xxxxxxx | インスタンスの ID です。 |
EnableBackupLog | String | 1 | ログバックアップ機能が有効かどうかを示します。 有効な値:
|
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 エラーセンター」をご参照ください。