インスタンスのバックアップポリシーを設定します。毎週月曜日、水曜日、金曜日の 20:00:00 など、特定の曜日にインスタンスをバックアップする週間スケジュールを設定できます。保持する完了済みバックアップの数を指定することもできます。期限切れのバックアップはシステムによって自動的に削除されます。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /api/v1/backups/scheduledConfig HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-beijing |
| body |
object |
任意 |
リクエストボディ。 |
|
| instanceId |
string |
任意 |
インスタンスの ID。 |
hgprecn-cn-zvp25ysxxxx |
| enabled |
boolean |
任意 |
スケジュールバックアップを有効にするかどうかを指定します。このパラメーターを true に設定するとスケジュールバックアップが有効になり、false に設定すると無効になります。 |
true |
| week |
string |
任意 |
バックアップを実行する曜日を指定します。複数の曜日はカンマで区切ります。たとえば、月曜日、水曜日、金曜日にバックアップを実行する場合、このパラメーターを 1,3,5 に設定します。 |
1,3,5 |
| hour |
integer |
任意 |
バックアップを開始する時間。この開始時刻は、指定されたすべての曜日に適用されます。たとえば、week を 1,3,5 に、hour を 20 にセットした場合、毎週月曜日、水曜日、金曜日の 20:00:00 にバックアップが開始されます。 |
20 |
| dataKeepQuantity |
integer |
任意 |
保持するスケジュールバックアップの数。たとえば、このパラメーターを 3 に設定した場合、システムは最新の 3 つのバックアップを保持し、それより古いバックアップを自動的に削除します。 |
3 |
| dstRegion |
string |
任意 |
バックアップのターゲットリージョン。このパラメーターはリモートバックアップにのみ適用され、クロスリージョンディザスタリカバリを有効にします。たとえば、中国 (杭州) から中国 (北京) にインスタンスをバックアップできます。 |
cn-beijing |
| zoneId |
string |
任意 |
バックアップの送信先アベイラビリティゾーン。このパラメーターはリモートバックアップにのみ適用されます。 |
cn-beijing-i |
| manualDataKeepQuantity |
integer |
任意 |
保持する手動バックアップの数。手動バックアップと自動バックアップは別々に保存され、それぞれ独立した保持ポリシーが適用されます。 |
3 |
| scheduleType |
string |
任意 |
バックアップタイプ。このパラメーターはリモートバックアップの場合にのみ必須です。 列挙値:
|
remote |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
操作で返されるデータ。 |
||
| RequestId |
string |
リクエストの ID。 |
69221013-D303-5046-91A7-A0BE2BC2E7D7 |
| Data |
boolean |
構成が成功したかどうかを示します。値が true の場合は成功、false の場合は失敗を示します。 |
True |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
True |
| ErrorCode |
string |
リクエストが失敗した場合に返されるエラーコード。 |
null |
| ErrorMessage |
string |
リクエストが失敗した場合に返されるエラーメッセージ。 |
null |
| HttpStatusCode |
string |
HTTP 状態コード。 |
200 |
例
成功レスポンス
JSONJSON
{
"RequestId": "69221013-D303-5046-91A7-A0BE2BC2E7D7",
"Data": true,
"Success": true,
"ErrorCode": "null",
"ErrorMessage": "null",
"HttpStatusCode": "200"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。