atlas clusters onlineArchives update
クラスターに対して指定されたオンラインアーカイブのアーカイブ ルールを変更します。
このコマンドを使用するには、プロジェクト データアクセス管理者ロールのユーザー アカウントまたは API キーで認証する必要があります。
構文
atlas clusters onlineArchives update <archiveId> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
archiveId | string | true | 更新対象のオンライン アーカイブの一意の識別子です。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--archiveAfter | 整数 | false | クラスター データをアーカイブする日数。 --file と相互に排他的。 |
--clusterName | string | true | クラスターの名前。 詳しくは、 https://docub.mongodb.org/core/create-cluster-api を参照してください。 |
--expireAfterDays | 整数 | false | 削除のドキュメントを指定するために日付基準で使用される日数。 --file と相互に排他的。 |
--file | string | false | オンライン アーカイブ設定を定義する任意の JSON 構成ファイルへのパス。 Atlas CLI 用のオンライン アーカイブ構成ファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-json-online-archive-config を参照してください。 --archiveAfter、-expireAfterDays と相互に排他的です。 |
-h, --help | false | 更新のヘルプ | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Online archive '<Id>' updated.
例
# Update the archiving rule to archive after 5 days for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: atlas clusters onlineArchives update 5f189832e26ec075e10c32d3 --clusterName --archiveAfter 5 myCluster --output json