指定されたプロジェクトに 1 つのクラスターを作成します。
atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。
クラスターには、同じデータセットを維持するホストのグループが含まれます。このリソースは、非対称サイズのシャードを持つクラスターを作成できます。各プロジェクトは最大 25 データベース配置をサポートします。この機能はサーバーレス クラスターでは利用できません。
M2 または M5 の instanceSize を使用すると、代わりに Flex クラスターが作成されることにご注意ください。M2 または M5 のインスタンスサイズのサポートは、1月2026に終了します。今後、このような構成には createFlexCluster API を使用することをお勧めします。
このコマンドは自動生成されており、1:1 は Atlas API エンドポイントとなる接続されたデバイス https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupcluster. に対応しています。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
コマンド構文
atlas api clusters createCluster [options]オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--file | string | false | APIリクエストファイルへのパス。代わりに標準入力を使用するには、 を空のままにします。どちらか一方を指定する必要がありますが、両方を指定することはできません。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | createCluster のヘルプ | |
-o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- outputFile | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pretty | false | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 | |
--version | string | false | Atlas API エンドポイントを呼び出すときに使用する API バージョン [options: "2023-01-01", "2023-02-01", "2024-08-05", "2024-10-23"]。ユーザーが設定しない場合は、最新バージョンまたはプロファイルの api_version 構成値が設定されている場合はその値がデフォルトになります。この値のデフォルトは "2024-10-23" です。 |
-w, --watch | false | コマンドの実行が完了するまで監視するか、監視がタイムアウトするまで監視するかを示すフラグ。 | |
--watchTimeout | 整数 | false | 監視がタイムアウトするまでの時間（秒単位）。 監視がタイムアウトすると、CLI は コマンドの監視を終了します。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
例
クラスター
以下のファイルを作成し、保存します payload.json
{ "clusterType": "SHARDED", "name": "myCluster", "replicationSpecs": [ { "regionConfigs": [ { "analyticsAutoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": false }, "diskGB": { "enabled": true } }, "analyticsSpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 0 }, "autoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": false }, "diskGB": { "enabled": true } }, "electableSpecs": { "diskSizeGB": 10, "instanceSize": "M50", "nodeCount": 3 }, "priority": 7, "providerName": "AWS", "readOnlySpecs": { "diskSizeGB": 10, "instanceSize": "M50", "nodeCount": 0 }, "regionName": "US_EAST_1" } ], "zoneName": "Zone 1" }, { "regionConfigs": [ { "analyticsAutoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": false }, "diskGB": { "enabled": true } }, "analyticsSpecs": { "diskSizeGB": 10, "instanceSize": "M30", "nodeCount": 0 }, "autoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": false }, "diskGB": { "enabled": true } }, "electableSpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 3 }, "priority": 7, "providerName": "AWS", "readOnlySpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 0 }, "regionName": "US_EAST_1" } ], "zoneName": "Zone 1" } ]}payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。
atlas api clusters createCluster --version 2024-08-05 --groupId 32b6e34b3d91647abb20e7b8クラスター
以下のファイルを作成し、保存します payload.json
{ "clusterType": "SHARDED", "name": "myCluster", "replicationSpecs": [ { "regionConfigs": [ { "analyticsAutoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": true, "maxInstanceSize": "M40", "minInstanceSize": "M30", "scaleDownEnabled": true }, "diskGB": { "enabled": true } }, "analyticsSpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 0 }, "autoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": true, "maxInstanceSize": "M60", "minInstanceSize": "M30", "scaleDownEnabled": true }, "diskGB": { "enabled": true } }, "electableSpecs": { "diskSizeGB": 10, "instanceSize": "M60", "nodeCount": 3 }, "priority": 7, "providerName": "AWS", "readOnlySpecs": { "diskSizeGB": 10, "instanceSize": "M60", "nodeCount": 0 }, "regionName": "US_EAST_1" } ], "zoneName": "Zone 1" }, { "regionConfigs": [ { "analyticsAutoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": true, "maxInstanceSize": "M40", "minInstanceSize": "M30", "scaleDownEnabled": true }, "diskGB": { "enabled": true } }, "analyticsSpecs": { "diskSizeGB": 10, "instanceSize": "M30", "nodeCount": 0 }, "autoScaling": { "autoIndexing": { "enabled": false }, "compute": { "enabled": true, "maxInstanceSize": "M60", "minInstanceSize": "M30", "scaleDownEnabled": true }, "diskGB": { "enabled": true } }, "electableSpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 3 }, "priority": 7, "providerName": "AWS", "readOnlySpecs": { "diskSizeGB": 10, "instanceSize": "M40", "nodeCount": 0 }, "regionName": "US_EAST_1" } ], "zoneName": "Zone 1" } ]}payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。
atlas api clusters createCluster --version 2024-10-23 --groupId 32b6e34b3d91647abb20e7b8MongoDB 6.0を実行中のAmazon Web Services の米国東部リージョンに新しい M10レプリカセットクラスターを作成します。
以下のファイルを作成し、保存します payload.json
{ "clusterType": "REPLICASET", "name": "MyCluster", "replicationSpecs": [ { "regionConfigs": [ { "electableSpecs": { "diskSizeGB": 10, "instanceSize": "M10", "nodeCount": 3 }, "priority": 7, "providerName": "AWS", "regionName": "US_EAST_1" } ] } ]}payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。
atlas api clusters createCluster --version 2024-10-23 --groupId [your-project-id]