実験的な : 指定されたプロジェクト内の 1 つのクラスターの詳細を返します。
クラスターには、同じデータセットを維持するホストのグループが含まれます。レスポンスには、非対称サイズのシャードがあるクラスターが含まれます。このリソースを使用するには、リクエスト元のAPIキーにプロジェクトの読み取り専用ロールが必要です。この機能はサーバーレス クラスターでは利用できません。このコマンドは、OpsID: 'getCluster' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Clusters/ 操作/ getCluster
構文
atlas api clusters getCluster [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterName | string | true | このクラスターを識別する、人間が判読できるラベル |
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数の文字列 |
-h, --help | false | getCluster 用のヘルプ | |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pretty | false | レスポンス本体を pretty-print形式にするかどうかを示すフラグ | |
--version | string | false | API呼び出しで使用するAPIバージョン [options: "2023-01-01", "2023-02-01", "2024-08-05"] は、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値をプロファイリングします。この値のデフォルトは "2024-08-05" です。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |