指定したクラスターをプロジェクトから削除します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される atlas api サブコマンドは、Admin APIの完全なカバレッジを提供し、現在パブリック プレビュー段階です（ フィードバックでフィードバックを提供してくださいforwards/930808 -atlas-cli ）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
-- force オプションを指定せずにコマンドを実行すると、コマンドによって操作の確認を求めるメッセージが表示されます。
クラスターを削除すると、そのクラスターのバックアップ スナップショットも削除されます。
このコマンドを使用するには、プロジェクト オーナーのユーザー アカウントまたは API キーで認証する必要があります。
構文
atlas clusters delete <clusterName> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
clusterName | string | true | 削除するクラスターの名前。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--force | false | 要求されたアクションを続行する前に確認プロンプトをスキップするかどうかを示すフラグ。 | |
-h, --help | false | 削除のヘルプ | |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
-w, --watch | false | コマンドの実行が完了するまで監視するか、監視がタイムアウトするまで監視するかを示すフラグ。 監視がタイムアウトする時間を設定するには --watchTimeout オプションを使用します。 | |
--watchTimeout | 整数 | false | 監視がタイムアウトするまでの時間（秒単位）。 監視がタイムアウトすると、CLI は コマンドの監視を終了します。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 http://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Deleting cluster '<Name>'
例
# Remove a cluster named myCluster after prompting for a confirmation: atlas clusters delete myCluster
# Remove a cluster named myCluster without requiring confirmation: atlas clusters delete myCluster --force