atlas clusters update
指定したクラスターの設定を変更します。
--file フラグを使用して、JSON 構成ファイルで変更を指定できます。
クラスターの名前を変更したり、クラスターの MongoDB バージョンをダウングレードしたりすることはできません。
単一シャード クラスターにはレプリカセットのみ更新できます。レプリカセットをマルチシャーディングされたクラスターに更新することはできません。 詳しくは、 https://www.mongodb.com/ja-jp/docs/atlas/ scale-cluster/ #convert-a-replica-set-to-a-sharded-cluster およびhttps://www.mongodb.com/ja-jp/docs/upcoming/tuned/convert-replica-set-to-replicated-shard-cluster
このコマンドを使用するには、プロジェクト クラスター マネージャー ロールを持つユーザー アカウントまたは API キーで認証する必要があります。 Atlas はこのコマンドを M10 以上のクラスターのみサポートしています
構文
atlas clusters update [clusterName] [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
clusterName | string | false | 更新するクラスターの名前。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--disableTerminationProtection | false | クラスターの終了保護を無効にします。 終了保護が無効になっているクラスターは削除できます。 --enable terminationProtection、--file と相互に排他的。 | |
--diskSizeGB | float | false | ホストのルート ボリュームの容量（ギガバイト単位）。 --file と相互に排他的。 |
--enable終了Protection | false | クラスターの終了保護を有効にします。 終了保護が有効になっているクラスターを削除することはできません。 --disable terminationProtection、--file と相互に排他的。 | |
-f, --file | string | false | クラスター設定を定義する任意の JSON 構成ファイルへのパス。 Atlas CLI のクラスター構成ファイルの詳細については、 https://docub.mongodb.org/core/cluster-config-file-atlascli を参照してください。 --tier、-diskSizeGB、-enable terminationProtection、--disable終了Protection、-map と相互に排他的です。 |
-h, --help | false | 更新のヘルプ | |
--mdbVersion | string | false | クラスターのメジャー MongoDB バージョン。 |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
--tag | key=value | false | クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。 このフラグを渡すと、既存のデータが置き換えられます。 --file と相互に排他的。 |
--tier | string | false | クラスター内の各データを保持するサーバーの階層。 クラスター階層の詳細については、 https://docub.mongodb.org/core/cluster-tier-atlas を参照してください。 --file と相互に排他的。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Updating cluster '<Name>'.
例
# Update the tier for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tier M50
# Replace tags cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag key1=value1
# Remove all tags from cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag =
# Update the disk size for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --diskSizeGB 20
# Update the MongoDB version for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --mdbVersion 5.0
# Use a configuration file named cluster-config.json to update a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --file cluster-config.json --output json