Atlas クラスター リスト
プロジェクト内のすべてのクラスターを返します。
このコマンドを使用するには、ユーザーアカウントまたはプロジェクト読み取り専用ロールの API キーで認証する必要があります。
構文
コマンド構文
atlas clusters list [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-h, --help | false | リスト用のヘルプ | |
--limit | 整数 | false | 結果ページあたりの項目数。最大 500 まで。 500 を超える結果がある場合は、結果ページを変更するために --page オプションを指定します。 この値のデフォルトは 100 です。 |
--omitCount | false | JSON 応答が JSON 応答内の項目の総数（ totalCount）を返すかどうかを示すフラグ。 | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--page | 整数 | false | 結果のページを指定するページ番号。 この値のデフォルトは 1 です。 |
--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 a JSON-formatted list of all clusters for the project with ID 5e2211c17a3e5a48f5497de3: atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --output json