ApsaraDB RDS インスタンスのバックアップポリシー設定を変更します。
操作説明
対象エンジン。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
rds:ModifyBackupPolicy |
update |
*DBInstance
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DBInstanceId |
string |
必須 |
インスタンスの ID。DescribeDBInstances を呼び出してインスタンス ID を取得できます。 |
rm-uf6wjk5**** |
| BackupPolicyMode |
string |
任意 |
バックアップタイプ。有効な値: |
DataBackupPolicy |
| PreferredBackupTime |
string |
任意 |
バックアップタスクを実行する時間。フォーマット: HH:mmZ-HH:mmZ (UTC)。 説明
|
00:00Z-01:00Z |
| PreferredBackupPeriod |
string |
任意 |
バックアップサイクル。少なくとも 2 日を指定する必要があります。複数の値はコンマ (,) で区切ります。有効な値: |
Monday |
| BackupRetentionPeriod |
string |
任意 |
データバックアップの保持日数。有効な値: 7~730。 説明
|
7 |
| BackupLog |
string |
任意 |
ログバックアップを有効にするかどうかを指定します。有効な値:
ApsaraDB RDS for SQL Server インスタンスの場合、ログバックアップはデフォルトで有効になっており、無効にすることはできません。ただし、ログバックアップの頻度は以下のように変更できます。
説明
このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効であり、ログバックアップの有効化または無効化に使用されます。 |
Enable |
| LogBackupRetentionPeriod |
string |
任意 |
ログバックアップの保持日数。有効な値: 7~730。この値はデータバックアップの保持日数を超えることはできません。 説明
|
7 |
| EnableBackupLog |
string |
任意 |
MySQL、PostgreSQL、および MariaDB インスタンスのログバックアップを有効にするかどうかを指定します。有効な値: |
1 |
| EnablePitrProtection |
boolean |
任意 |
MySQL インスタンスのポイントインタイムリカバリを有効にするかどうかを指定します。有効な値:
説明
このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定され、かつ BackupLog が Enable に設定されている場合にのみ有効です。詳細については、「ポイントインタイムリカバリポリシーの設定」をご参照ください。 |
True |
| LocalLogRetentionHours |
string |
任意 |
MySQL インスタンスのローカルストレージにインスタンスログバックアップを保持する時間数。有効な値: 0~168 (7 × 24)。0 は、インスタンスログバックアップがローカルに保持されないことを示します。 |
18 |
| LocalLogRetentionSpace |
string |
任意 |
MySQL インスタンスのローカルログストレージ領域の最大使用量。使用量がこの値を超えると、システムは最も古いバイナリログから削除を開始し、使用量がこのしきい値を下回るまで続けます。有効な値: 0~50。デフォルトでは、このパラメーターは変更済みではありません。 |
30 |
| HighSpaceUsageProtection |
string |
任意 |
MySQL インスタンスのストレージ使用量が 80% を超えるか、または残りのストレージが 5 GB 未満になった場合に、無条件でバイナリログを削除するかどうかを指定します。有効な値: Enable | Disable。デフォルトでは、このパラメーターは変更済みではありません。 |
Enable |
| LogBackupFrequency |
string |
任意 |
SQL Server インスタンスのログバックアップ頻度。有効な値:
説明
このパラメーターは、BackupPolicyMode パラメーターが DataBackupPolicy に設定されている場合にのみ有効です。 |
LogInterval |
| CompressType |
string |
任意 |
バックアップの圧縮方式。有効な値:
説明
このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。 |
4 |
| ArchiveBackupRetentionPeriod |
string |
任意 |
アーカイブバックアップの保持日数。デフォルト値: 0 (アーカイブバックアップが無効であることを示します)。有効な値: 30~1095。 |
365 |
| ArchiveBackupKeepPolicy |
string |
任意 |
アーカイブバックアップの保持サイクル。このサイクル内に保持できるバックアップ数は ArchiveBackupKeepCount によって決定されます。デフォルト値: 0。有効な値: |
ByMonth |
| ArchiveBackupKeepCount |
integer |
任意 |
保持するアーカイブバックアップの数を指定します。デフォルト値: 1。有効な値:
説明
|
1 |
| ReleasedKeepPolicy |
string |
任意 |
MySQL 削除されたインスタンスのバックアップ保持ポリシー。有効な値:
説明
|
None |
| LogBackupLocalRetentionNumber |
integer |
任意 |
ローカルに保持されるバイナリログファイルの数。デフォルト値: 60。有効な値: 6 ~ 100。 説明
|
60 |
| Category |
string |
任意 |
秒単位のバックアップを有効にするかどうかを指定します。有効な値:
説明
このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。 |
Standard |
| BackupInterval |
string |
任意 |
スナップショットバックアップの頻度。有効な値:
説明
|
30 |
| BackupMethod |
string |
任意 |
クラウドディスクを使用する SQL Server インスタンスのバックアップ方法。有効な値:
説明
このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。 |
Physical |
| EnableIncrementDataBackup |
boolean |
任意 |
クラウドディスクを使用する SQL Server インスタンスまたはローカルディスクを使用する MySQL インスタンスの増分バックアップを有効にするかどうかを指定します。有効な値: |
False |
| IncBackupInterval |
integer |
任意 |
ローカルディスクを使用する MySQL インスタンスの高クロック周波数増分バックアップのバックアップ頻度。有効な値: |
120 |
| BackupPriority |
integer |
任意 |
SQL Server Cluster Edition インスタンスのセカンダリバックアップ設定。有効な値: |
2 |
| EnableAdvancedBackupPolicy |
integer |
任意 |
||
| AdvancedDataPolicies |
array<object> |
任意 |
||
|
object |
任意 |
|||
| StrategyId |
string |
任意 |
||
| ActionType |
string |
任意 |
||
| OnlyPreserveOneEachHour |
boolean |
任意 |
||
| RetentionValue |
integer |
任意 |
||
| BakType |
string |
任意 |
||
| FilterKey |
string |
任意 |
||
| FilterValue |
string |
任意 |
||
| DestType |
string |
任意 |
||
| FilterType |
string |
任意 |
||
| SrcRegion |
string |
任意 |
||
| OnlyPreserveOneEachDay |
boolean |
任意 |
||
| SrcType |
string |
任意 |
||
| DestRegion |
string |
任意 |
||
| RetentionType |
string |
任意 |
||
| AdvancedLogPolicies |
array<object> |
任意 |
||
|
object |
任意 |
|||
| StrategyId |
string |
任意 |
||
| ActionType |
string |
任意 |
||
| LogRetentionType |
string |
任意 |
||
| DestType |
string |
任意 |
||
| EnableLogBackup |
integer |
任意 |
||
| SrcType |
string |
任意 |
||
| SrcRegion |
string |
任意 |
||
| LogRetentionValue |
integer |
任意 |
||
| DestRegion |
string |
任意 |
||
| FilterKey |
string |
任意 |
||
| FilterValue |
string |
任意 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| CompressType |
string |
バックアップの圧縮方式。有効な値:
|
4 |
| DBInstanceID |
string |
インスタンスの ID。 |
rm-uf6wjk5**** |
| EnableBackupLog |
string |
ログバックアップが有効かどうかを示します。有効な値:
説明
SQL Server インスタンスでは、ログバックアップはデフォルトで有効になっており、無効にすることはできません。 |
1 |
| HighSpaceUsageProtection |
string |
MySQL インスタンスのストレージ使用量が 80% を超えるか、または残りのストレージが 5 GB 未満になった場合に、バイナリログが無条件で削除されるかどうかを示します。 |
Disable |
| LocalLogRetentionHours |
integer |
MySQL インスタンスのローカルストレージにインスタンスログバックアップが保持される時間数。 |
18 |
| LocalLogRetentionSpace |
string |
MySQL インスタンスのバイナリログストレージの最大ループ領域使用量。 |
30 |
| LogBackupLocalRetentionNumber |
integer |
MySQL インスタンスに対してローカルに保持されるバイナリログの数。 |
60 |
| RequestId |
string |
リクエスト ID。 |
DA147739-AEAD-4417-9089-65E9B1D8240D |
| EnableIncrementDataBackup |
boolean |
||
| IncBackupInterval |
integer |
||
| EnablePitrProtection |
boolean |
例
成功レスポンス
JSONJSON
{
"CompressType": "4",
"DBInstanceID": "rm-uf6wjk5****",
"EnableBackupLog": "1",
"HighSpaceUsageProtection": "Disable",
"LocalLogRetentionHours": 18,
"LocalLogRetentionSpace": "30",
"LogBackupLocalRetentionNumber": 60,
"RequestId": "DA147739-AEAD-4417-9089-65E9B1D8240D",
"EnableIncrementDataBackup": false,
"IncBackupInterval": 0,
"EnablePitrProtection": false
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidColdRetention.Format | Invalid cold retention format. | |
| 400 | InvalidLogBackupFrequency.Malformed | Invalid log backup frequency. | ログバックアップ頻度 (LogBackupFrequency) が有効ではありません。パラメーターが正しいか確認してください。 |
| 400 | InvalidBackupRetentionPeriod.Malformed | The specified backup retention period is invalid. | バックアップサイクルが無効です。 |
| 400 | BackupPropertyNotFound | Backup policy not found | バックアップポリシーが見つからなかったため、操作は失敗しました。 |
| 400 | OperationDenied.SwitchToSnapshot | Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode. | 操作は失敗しました。スナップショットバックアップは現在、クロスリージョンストレージをサポートしていません。スナップショットバックアップモードに切り替える前に、クロスリージョンバックアップを無効にしてください。 |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | インスタンスリリース後のアーカイブバックアップデータの保持ポリシーが無効です。 |
| 400 | IncorrectBackupPolicy | The current instance has an advanced backup policy enabled. Currently, you cannot use the OpenAPI to modify the backup policy. You need to modify the backup policy in the console. | 現在のインスタンスで高度なバックアップポリシーが有効になっています。OpenAPI を使用したバックアップポリシーの変更はサポートされていません。コンソールでバックアップポリシーを変更してください。 |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | パッケージインスタンスに対して個別の操作を行うことはできません。 |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 料金プランの価格結果が見つかりませんでした。 |
| 400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | 実名認証が完了していないため、購入資格がありません。料金・コスト管理にログインして実名認証を完了してください。 |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | アカウントの利用可能額が 0 未満です。購入を試みる前にアカウントをチャージしてください。 |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 商品サービスへの呼び出しに失敗しました。 |
| 400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | Alibaba Cloud は現在のリージョンの最適化および調整を予定しています。このリージョンのクラウドサービスは終了されます。業務継続性とスムーズなデータ移行を確保するため、現時点では新規購入注文を行うことができません。ご理解とご支援のほどよろしくお願いいたします。 |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | 購入したモジュールが無効です。有効なモジュールを購入してください。 |
| 400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | リージョンが廃止されました。 |
| 400 | Price.CommoditySys | Commodity system call exception. | 商品システムの呼び出し時に例外が発生しました。 |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | 選択したサブスクリプション期間が無効です。有効な期間を選択してください。 |
| 400 | pay.noCreditCard | Account not bound to credit card. | 利用可能なクレジットカードがありません。 |
| 400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | 選択したサービスに未払いの注文があります。新しい注文を行う前に、既存の注文の支払いを完了するかキャンセルしてください。 |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | アカウントに支払方法が設定されていません。支払方法を追加してください。 |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | 基本情報が不完全です。この操作を実行する前に、基本情報のフォームを完了させてください。フォーマットを確認してください。 |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | アカウントで例外が発生しました。詳細についてはカスタマーサービスにお問い合わせください。 |
| 400 | Api.NotSupport | Specified api is not supported. | 現在の API オペレーションはサポートされていません。 |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | 注文ブロックタグが存在します。この問題を解決するには、販売代理店にお問い合わせください。 |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | 指定された DBInstanceId が存在しません。 |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | 現在のインスタンスタイプは、指定されたストレージタイプをサポートしていません。 |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | 入力パラメーターが無効です。 |
| 400 | KmsApiError | User secret key invalid. | ユーザーキーが無効です。 |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | Alibaba Cloud アカウントが存在しないか、AccessKey が期限切れです。 |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | SQL コマンドの実行に失敗したか、または時間切れになりました。 |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | 現在のインスタンスの DPI エンジンバージョンは、コールドデータアーカイブをサポートしていません。 |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | 現在のカーネルバージョンは、コールドデータアーカイブをサポートしていません。 |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | 現在のインスタンスの仕様では、この操作はサポートされていません。 |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | エンドポイント名が重複しています。接続文字列を再設定してください。 |
| 400 | RequiredParam.NotFound | Required input param is not found. | 必須パラメーターが不足しています。 |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | パラメーターが正しくありません。パラメーターを確認してください。 |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | 現在のバックアップポリシーではこの操作はサポートされていません。 |
| 400 | InvalideStatus.Format | The instance status does not support this operation. | インスタンスステータスはこの操作をサポートしていません。 |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | インスタンスのデータベースエンジンタイプはこの操作をサポートしていません。 |
| 400 | Pay.NoCreditCard | No credit cards. | |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | この操作は、VPC ネットワークタイプのインスタンスではサポートされていません。 |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | 現在のデータベースインスタンスのイメージが既に存在します。読み取りを確認してください。 |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | このインスタンスタイプは購入できなくなりました。 |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | 指定されたデータベースがバックアップセットに存在しません。 |
| 400 | OrdTCommodityQueryError | Failed to query for product. | プロダクトのクエリに失敗しました。 |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | インスタンスはリリースされています。注文を行う前にインスタンスを確認してください。 |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | 指定されたリージョンが無効です。 |
| 400 | InvalidDiskType | Current disk type does not support this operation. | 現在のディスクタイプではこの操作はサポートされていません。 |
| 400 | InvalidIncrementBackupInterval.Malformed | Parameter 'IncBackupInterval' is invalid. | IncBackupInterval パラメーターの値が無効です。 |
| 400 | InvalidLocalLogRetentionSpace.Malformed | Parameter 'LocalLogRetentionSpace' is invalid. | LocalLogRetentionSpace パラメーターの値が無効です。 |
| 400 | InvalidLocalLogRetentionHours.Malformed | Parameter 'LocalLogRetentionHours' is invalid. | LocalLogRetentionHours パラメーターの値が無効です。 |
| 400 | InvalidLogBackupLocalRetentionNumber.Malformed | Parameter 'LogBackupLocalRetentionNumber' is invalid. | LogBackupLocalRetentionNumber パラメーターの値が無効です。 |
| 400 | InvalidBackupInterval.Unsupported | BackupInterval can be configured only when Category is set to Standard. The current instance is set to Flash. Please set Category to Standard. | 現在のインスタンスは秒単位のバックアップ (Category=Flash) を有効にしています。BackupInterval パラメーターは Category の値が標準の場合にのみ設定できます。設定項目で Category の値を標準にセットしてから、BackupInterval パラメーターを設定してください。 |
| 400 | InvalidPitrSetting | Log backup is disabled. Enable PITR requires log backup to be enabled. | ログバックアップが無効になっています。ポイントインタイム回復を有効にするには、ログバックアップを有効にする必要があります。 |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | サービスへのリクエストが失敗しました。後でもう一度お試しください。 |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | サービスリクエストに失敗しました。後でもう一度お試しいただくか、サポートにお問い合わせください。 |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | RDS API サービスの障害により、リクエストの処理が失敗しました。 |
| 403 | IncorrectCategory | Current Instance type does not support Category. | 現在のインスタンスタイプではこのカテゴリはサポートされていません。 |
| 403 | OperationDenied.SwitchSnapshotToPhysical | Only physical backup to snapshot backup is supported. | 現在の操作では、物理バックアップからスナップショットバックアップへの切り替えのみがサポートされています。 |
| 403 | OperationDenied.ModifyBackupSwitchOff | The switch is not turned on. It is forbidden to modify the backup mode. | クロスリージョンバックアップが有効になっていないため、スイッチオーバーは失敗しました。 |
| 403 | OperationDenied.ApiForbiddenForLogBackupFrequency | When the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup. | インスタンスがスナップショットバックアップを使用している場合、ログバックアップ頻度を「データバックアップと同じ」に設定することはできません。 |
| 403 | OperationDenied.NotSupportedBackupMethod | When the storage is larger than 4000 GB, only snapshot backup is supported. | ストレージ容量が 4000 GB を超える場合、スナップショットバックアップのみがサポートされます。 |
| 403 | OperationDenied.ApiForbidden | Operation is not permitted. | この操作は許可されていません。 |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | 現在のインスタンスに未払いの注文があります。注文の支払いを完了してから再試行してください。 |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | スケールダウンのターゲット容量を現在のストレージ使用量より小さくすることはできません。 |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | SSD ディスクはこの操作をサポートしていません。ESSD にアップグレードしてください。 |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | ユーザー権限ではこの操作はサポートされていません。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定された VSwitchId のフォーマットが正しくないか、または空です。 |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 現在のマイナーバージョンでは、この操作はサポートされていません。 |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | 利用可能な在庫リージョンがありません。 |
| 403 | NotInFlowController | Sorry,no permission. | この特徴は利用できません。法人クラウドユーザーではないため、権限がありません。 |
| 403 | InvalidKmsKey | Kms key is disabled. | KMS キーが無効化されています。 |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | 現在のデータベースインスタンスレベルは、この操作をサポートしていません。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 現在のインスタンスステータスではこの操作はサポートされていません。 |
| 403 | InvalidBackupLogStatus | Current backup log enable status does not support this operation. | 操作が失敗しました。ログバックアップが有効になっていません。ポイントインタイム復元は利用できません。 |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | 現在のインスタンスは Key Management Service へのアクセスを許可されていません。 |
| 404 | Request.NotFound | The requested resource is not available. | リクエストされたリソースは利用できません。 |
| 404 | HostInfo.NotFound | The specified host info is not found. | 指定されたホスト情報が存在しません。 |
| 404 | InvalidInsType.Malformed | Specified instance type is not valid. | インスタンスタイプが無効です。 |
| 404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作が失敗しました。インスタンスがロック済み状態にあります。 |
| 408 | NetworkOrSqlTimeoutError | Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later. | SQL Server の過負荷またはインスタンスアカウントが多すぎる可能性があるため、クエリが時間切れになりました。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。