Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

atlas api clusters deleteCluster

パブリック プレビュー:フィードバックを提供してください : 指定されたプロジェクトから 1 つのクラスターを削除します。

パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です(フィードバック 930808-Atlas-cli )。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。

クラスターを削除するには、終了保護を無効にする必要があります。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。この機能はサーバーレス クラスターでは利用できません。

このエンドポイントは、 createCluster エンドポイントを使用して作成された Flex クラスター、または 1 月2026まで Flex クラスターに移行された以前の M2/M5 クラスターでも使用できます。代わりに Flex クラスターの deleteFlexCluster エンドポイントを使用してください。

このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-deletecluster

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

コマンド構文
atlas api clusters deleteCluster [options]
名前
タイプ
必須
説明

--clusterName

string

true

クラスターを識別する人間が判読できるラベル。

-- envelope

envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

--groupId

string

true

プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。

: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

-h, --help

false

deleteCluster のヘルプ

-o, --output

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

-- outputFile

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" になります。

-w, --watch

false

コマンドの実行が完了するまで監視するか、監視がタイムアウトするまで監視するかを示すフラグ。

--watchTimeout

整数

false

監視がタイムアウトするまでの時間(秒単位)。 監視がタイムアウトすると、CLI は コマンドの監視を終了します。

名前
タイプ
必須
説明

-P, --profile

string

false

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

atlas api clusters deleteCluster --version 2023-02-01 --clusterName [your-cluster-name] --groupId [your-project-id]

項目一覧