プロジェクトの指定されたクラスターの詳細を返します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される atlas api サブコマンドは、Admin APIの完全なカバレッジを提供し、現在パブリック プレビュー段階です（ フィードバックでフィードバックを提供してくださいforwards/930808 -atlas-cli ）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
このコマンドを使用するには、ユーザーアカウントまたはプロジェクト読み取り専用ロールの API キーで認証する必要があります。
構文
atlas clusters describe <clusterName> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
clusterName | string | true | 検索するクラスターの名前。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-h, --help | false | 説明用のヘルプ | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
ID NAME MDB VER STATE <Id> <Name> <MongoDBVersion> <StateName>
例
# Return the JSON-formatted details for the cluster named myCluster: atlas clusters describe myCluster --output json