Atlas バックアップのスケジュールの更新
プロジェクトの指定されたクラスターのバックアップ スケジュールを変更します。
バックアップ スケジュールは、MongoDB がスケジュールされたスナップショットをいつ取得するか、またそれらのスナップショットをどのくらいの期間保存するかを定義します。
このコマンドを使用するには、プロジェクト オーナーのユーザー アカウントまたは API キーで認証する必要があります。
構文
atlas backups schedule update [options]
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
--autoExport | false | Amazon Web Servicesバケットへのクラウドバックアップ スナップショットの自動エクスポートを有効にするフラグ。 --noAutoExport、 --file と相互に排他的です。 | |
--clusterName | string | true | クラスターの名前。 詳しくは、 https://docub.mongodb.org/core/create-cluster-api を参照してください。 |
--exportBucketId | string | false | Atlas がバケットに割り当てる一意の識別子。 --file と相互に排他的。 |
--exportFrequencyType | string | false | エクスポート ポリシーに関連付けられている頻度。 値は、毎日、毎週、または毎月指定できます。 --file と相互に排他的。 |
-f, --file | string | false | バックアップ スケジュール設定を定義する任意の JSON 構成ファイルへのパス。 Atlas CLI のクラウドバックアップ構成ファイルの詳細については、 https://docub.mongodb.org/core/cloud-backup-config-file を参照してください。 --exportBbucketId、-exportFrequencyType、-referenceHourOfDay、-referenceMinuteOfHour、 --restoreWindowDays、 -- autoExport、 --noAutoExport、 --updateSnapshots、 --noUpdateSnapshots、 --useOrgAndGroupNamesInExportPrefix、 --noUseOrgAndGroupNamesInExportPrefix、--olicy と相互に排他的。 |
-h, --help | false | 更新のヘルプ | |
--noAutoExport | false | Amazon Web Servicesバケットへのクラウドバックアップ スナップショットの自動エクスポートを無効にするフラグ。 -- autoExport、 --file と相互に排他的です。 | |
--noUpdateSnapshots | false | 更新されたバックアップ ポリシー内の保持変更を、Atlas が以前に取得したスナップショットに適用することを無効にするフラグ。 --updateSnapshots、-file と相互に排他的。 | |
--noUseOrgAndGroupNamesInExportPrefix | false | Atlas がスナップショットのエクスポートを完了した後に S3 バケットにアップロードするメタデータ ファイルのパスに、組織 UUID とプロジェクト UUID の代わりに組織名とプロジェクト名を使用を無効にするフラグ。 --useOrgAndGroupNamesInExportPrefix、 --file と相互に排他的です。 | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--policy | stringArray | false | 更新されたバックアップ ポリシー内の各バックアップ ポリシー項目のドキュメントを含む配列。 これは次の形式で指定する必要があります。 --file と相互に排他的。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
--referenceHourOfDay | 整数 | false | 24 時間制でスナップショットをスケジュールする時刻。 指定できる値は 0 から 23 までです。 --file と相互に排他的。 |
--referenceMinuteOfHour | 整数 | false | スナップショットをスケジュールする時間の 分。 指定できる値は、両端を含む 0 から 59 までです。 --file と相互に排他的。 |
--restoreWindowDays | 整数 | false | 継続的なクラウドバックアップの精度で に復元できる過去の日数。 0 以外の正の整数である必要があります。 継続的なクラウドバックアップにのみ適用されます。 --file と相互に排他的。 |
--updateSnapshots | false | 更新されたバックアップ ポリシー内の保持の変更を、Atlas が以前に取得したスナップショットに適用できるようにするフラグ。 --noUpdateSnapshots、 --file と相互に排他的。 | |
--useOrgAndGroupNamesInExportPrefix | false | Atlas がスナップショットのエクスポートを完了した後に S3 バケットにアップロードするメタデータ ファイルのパスに、組織 UUID とプロジェクト UUID の代わりに組織名とプロジェクト名を使用できるようにするフラグ。 --noUseOrgAndGroupNamesInExportPrefix、 --file と相互に排他的です。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Snapshot backup policy for cluster '<ClusterName>' updated.
例
# Update a snapshot backup policy for a cluster named Cluster0 to back up snapshots every 6 hours and, retain for 7 days, and update retention of previously-taken snapshots: atlas backup schedule update --clusterName Cluster0 --updateSnapshots --policy 62da8faac84a2721e448d767,62da8faac84a2721e448d768,hourly,6,days,7
# Update a snapshot backup policy for a cluster named Cluster0 to export snapshots monthly to an S3 bucket: atlas backup schedule update --clusterName Cluster0 --exportBucketId 62c569f85b7a381c093cc539 --exportFrequencyType monthly