atlas api clusters deleteCluster

: このバージョンのドキュメントはアーカイブされており、サポートされなくなりました。 Atlas CLI のバージョンをアップグレードする方法については、現在のドキュメントを表示してください。

実験的な : 指定されたプロジェクトから 1 つのクラスターを削除します。

クラスターを削除するには、終了保護を無効にする必要があります。このリソースを使用するには、リクエスト元のAPIキーにプロジェクトオーナーのロールが必要です。この機能はサーバーレスクラスターでは利用できません。このコマンドは、OpsID: 'deleteCluster' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Clusters/ 操作/ deleteCluster

構文

コマンド構文

atlas api clusters deleteCluster [options]

オプション

名前	タイプ	必須	説明
--clusterName	string	true	クラスターを識別する、人間が判読できるラベル
-- envelope		false	アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ
--groupId	string	true	プロジェクトを識別する一意の 24 桁の 16 進数の文字列
-h, --help		false	deleteCluster のヘルプ
--出力	string	false	優先API形式は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。
-- output-file	string	false	API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。
--pretty		false	レスポンス本体を pretty-print形式にするかどうかを示すフラグ
--retainBackups		false	削除された専有クラスターのバックアップショットを保持するかどうかを示すフラグ
--version	string	false	API 呼び出しで使用する API バージョン [options: "2023-01-01", "2023-02-01"] は、デフォルトで最新バージョンまたはプロファイル api_version設定されている場合の構成値この値はデフォルトで "2023-02-01" になります。

継承されたオプション

名前	タイプ	必須	説明
-P, --profile	string	false	構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。

戻る

createCluster

getCluster