1 つの Atlas エフェメラル クラスターの詳細を返します。
atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。
エフェメラル クラスターの詳細については、 MongoDB Atlasドキュメントの「 Atlas エフェメラル クラスターの作成 」を参照してください。
このコマンドは自動生成され、Atlas APIエンドポイント の:1 1https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-getephemeralcluster.に対応しています。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api ephemeralClusters getEphemeralCluster [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterId | string | true | 検索対象のエフェメラル クラスターの一意のID 。 |
-h, --help | false | getEmitter のヘルプ | |
-o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- outputFile | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--version | string | false | Atlas APIエンドポイントを呼び出すときに使用するAPIバージョン [options: "プレビュー"] 。ユーザーによって設定されない場合は、デフォルトで最新バージョンになるか、プロファイルの api_version 構成値 （設定されている場合）になります。この値のデフォルトは「プレビュー」です。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |