指定されたオンラインアーカイブをクラスターから削除します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なカバレッジを提供し、現在パブリック プレビュー段階です(フィードバックでフィードバックを提供してくださいフォーラム/930808-Atlas-cli)。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
このコマンドを使用するには、プロジェクト データアクセス管理者ロールのユーザー アカウントまたは API キーで認証する必要があります。
構文
atlas clusters onlineArchives delete <archiveId> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
archiveId | string | true | 削除するオンライン アーカイブの一意の識別子。 |
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
--clusterName | string | true | クラスターの名前。詳細については、 https://docub.mongodb.org/core/create-cluster-api を参照してください。 |
--force | false | 要求されたアクションを続行する前に確認プロンプトをスキップするかどうかを示すフラグ。 | |
-h, --help | false | 削除のヘルプ | |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Archive '<Name>' deleted
例
# Remove an online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: atlas clusters onlineArchives delete 5f189832e26ec075e10c32d3 --clusterName myCluster