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

この API は、インスタンスのバックアップポリシーを設定します。毎週月曜日、水曜日、金曜日の 20:00:00 など、特定の曜日にインスタンスをバックアップする週次スケジュールを設定できます。また、保持する完了済みバックアップの数を指定することもできます。システムは期限切れのバックアップを自動的に削除します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

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	任意	バックアップの送信先リージョンを指定します。このパラメータはリモートバックアップにのみ適用され、クロスリージョンディザスタリカバリを実現します。たとえば、China (Hangzhou) のインスタンスを China (Beijing) にバックアップできます。	cn-beijing
zoneId	string	任意	バックアップの送信先アベイラビリティーゾーンを指定します。このパラメータはリモートバックアップにのみ適用されます。	cn-beijing-i
manualDataKeepQuantity	integer	任意	保持する手動バックアップの数を指定します。手動バックアップと自動バックアップは別々に保存され、それぞれに独立した保持ポリシーがあります。	3
scheduleType	string	任意	バックアップのタイプを指定します。このパラメータはリモートバックアップの場合にのみ必要です。列挙値: periodical : スケジュールされたバックアップ remote : リモートバックアップ	remote

レスポンスフィールド

フィールド	型	説明	例
	object	API によって返されるデータ。
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"
}

エラーコード

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

変更履歴

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