指定されたプロジェクトの共有階層クラスターを Flex または専有(M10+)クラスターにアップグレードします。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーのロールが必要です。各プロジェクトは最大 25 クラスターに対応します。
このエンドポイントは、 createCluster APIを使用して作成された Flex クラスター、または2 5Flex クラスターに移行された以前の M /M クラスターをアップグレードするためにも使用できます。これは instanceSizeName を2 M または M{6} 1 月2026 までの「 」。この機能は 年 1 月2026 日まで使用でき、その後は M0 クラスターでのみ使用できます。代わりに、アップグレード FlexCluster エンドポイントを使用してください。
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。
デフォルト値はfalseです。
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値はfalseです。
指定されたプロジェクト内の共有階層クラスターのアップグレードの詳細。
リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み(過半数がコミットされた書込みであっても)が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。 このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
高度な構成の詳細のサブセットを構成する設定のグループ。
TLS 1.2 のカスタム OpenSSL 暗号スイート リスト。 このフィールドは、tlsCipherConfigMode が CUSTOM に設定されている場合にのみ有効です。
値は TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 または TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 です。
クラスターが受信接続に受け入れる TLS(Transport Layer Security)の最小バージョン。TLS 1.0 または 1.1 を使用するクラスターでは、TLS プロトコルの最小バージョンとして TLS 1.2 を設定することを検討する必要があります。
値は TLS1_0、TLS1_1、または TLS1_2 です。
TLS 暗号スイートの 構成モード。 デフォルトモードでは、デフォルトの暗号スイートが使用されます。 カスタムモードでは、 TLS 1.2 と TLS 1.3 の両方のカスタム暗号スイートを指定できます。
値は CUSTOM または DEFAULT です。
クラスターを増やすことができるインスタンス サイズの範囲。
クラスターがクラスター層を増やす方法と、クラスターが増やすダウンできるかどうかを構成する設定のコレクション。低 CPU または NVMEストレージクラスを使用するクラスターでは、クラスター階層のオートスケーリングは使用できません。
インスタンスサイズのリアクティブなオートスケーリングが有効になっているかどうかを示すフラグ。
trueインスタンスサイズのリアクティブなオートスケーリングを有効にするには、 に設定します。有効にする場合は、 providerSettings.autoScaling.compute.maxInstanceSize の値を指定する必要があります。false に設定します。デフォルト値はfalseです。
予測インスタンスサイズのオートスケーリングが有効になっているかどうかを示すフラグ。
true予測インスタンスサイズのオートスケーリングを有効にするには、 に設定します。この機能を有効にするには、 MongoDBが trueである必要があります。false に設定します。デフォルト値はfalseです。
リアクティブなオートスケーリングによってクラスター層を増やすダウンできるかどうかを示すフラグ。 autoScaling.compute.enabled が の場合は、これが必要です。このオプションを有効にする場合は、true providerSettings.autoScaling.compute.minInstanceSize の値を指定します。
デフォルト値はfalseです。
このクラスターでディスクのオートスケーリングが有効になっているかどうかを示すフラグ。
デフォルト値はfalseです。
クラスターがバックアップを実行できるかどうかを示すフラグ。true に設定されていると、クラスターはバックアップを実行できます。NVMe クラスターの場合、この値を true に設定する必要があります。バックアップは、専用クラスターにはクラウドバックアップを使用し、テナントクラスターには共有クラスターバックアップを使用します。false に設定されていると、クラスターは MongoDB Cloud バックアップを使用しません。
このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。
MongoDB Connector for Business Intelligence が指定されたクラスターで有効になっているかどうかを示すフラグ。
MongoDB Cloud 上のMongoDB Connector for Business Intelligence に指定されたデータソースノード。 MongoDB Cloud 上のMongoDB Connector for Business Intelligence は、 読み込み設定(read preference) に基づいて、プライマリ、セカンダリ、または分析ノードからデータを読み取ります。デフォルトは ANALYTICSノード、または ANALYTICS ノードがない場合は SECONDARY になります。
値は PRIMARY、SECONDARY、または ANALYTICS です。
クラスターを構成するノードの構成。
値は REPLICASET、SHARDED、または GEOSHARDED です。
シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバー マネジメント モード。
ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスとコスト削減のために、クラスターのコンフィギュレーションサーバーの種類を自動的に切り替える場合があります。
FIXED_TO_DEDICATED として構成すると、クラスターは常に専用のコンフィギュレーションサーバーを使用します。
値は ATLAS_MANAGED または FIXED_TO_DEDICATED です。デフォルト値は ATLAS_MANAGED です。
インスタンス データ ボリュームのストレージ容量(ギガバイト単位)。 この数を増やすと、容量が追加されます。
この値は、M 0 /M 2 /M 5クラスターでは構成できません。
MongoDB Cloud では、replicationSpecs を設定する場合にこのパラメータが必要です。
最小( 10 GB)より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。
ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。
ディスク ストレージの最大値は、選択したクラスターの最大 RAM の50倍を超えることはできません。 より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。
最小値は 10、最大値は 4096 です。
ディスク ウォーミング モードの選択。
値は FULLY_WARMED または VISIBLE_EARLIER です。デフォルト値は FULLY_WARMED です。
カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。保管時の暗号化のためのカスタマー キー管理を有効にするには、クラスター eplicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize の設定は、M10 以上、かつ "backupEnabled" : false または完全に省略する必要があります。
値は、NONE、AWS、AZURE、または GCP です。
新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。
false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。
true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。
この設定は、クラスターが配置されると変更できません。
クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。
クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めします。
このMongoDB Cloud コンポーネントに適用された、人間が判読可能なラベル。
MongoDB 従業員に付与されるクラスターのアクセスレベルと有効期限。
クラスターの MongoDB メジャー バージョン。
作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョン エンドポイントの API エンドポイントを使用してください。
更新時: 一度に1メジャー バージョンを つだけ上げてください。 クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。
クラスターが実行する MongoDB のバージョン。
形式は次のパターンと一致する必要があります: ([\d]+\.[\d]+\.[\d]+)。
クラスターを識別する人間が判読できるラベル。
形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$。
シャーディングされたクラスターに配置できるシャードの数は最大 50 個です。リソースは、レプリカセットを示す場合は 1 を返し、シャーディングされたクラスターを示す場合は 2 以上の値を返します。戻り値は、クラスター内のシャードの数と等しくなります。
最小値は 1、最大値は 50 です。デフォルト値は 1 です。
クラスターが一時停止しているかどうかを示すフラグ。
クラスターが継続的なクラウドバックアップを使用するかどうかを示すフラグ。
M10 以上のクラスターがクラウドバックアップを実行できるかどうかを示すフラグ。true に設定されていると、クラスターはバックアップを実行できます。これと backupEnabled が false に設定されている場合、クラスターは MongoDB Cloud バックアップを使用しません。
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
値は AWS です。
クラスターを増やすことができるインスタンス サイズの範囲。
クラスターがクラスター層を増やす方法と、クラスターが増やすダウンできるかどうかを構成する設定のコレクション。低 CPU または NVMEストレージクラスを使用するクラスターでは、クラスター階層のオートスケーリングは使用できません。
クラスターがオート増やすできる最大インスタンスサイズ
値は M10、M20、M30、M40、M50、M60、M80、M100、M140、M200、M300、R40、 R50、R60、R80、R200、R300、R400、R700、M40_NVME、M50_NVME、M60_NVME、M80_NVME、M200_NVME、または M400_NVME。
クラスターが オート増やすできる最小インスタンスサイズ。
値は M10、M20、M30、M40、M50、M60、M80、M100、M140、M200、M300、R40、 R50、R60、R80、R200、R300、R400、R700、M40_NVME、M50_NVME、M60_NVME、M80_NVME、M200_NVME、または M400_NVME。
データベースホストが実行できる 1 秒あたりの最大ディスク入力/出力操作数(IOPS)。
EBS( Amazon Elastic Block Store)暗号化機能が、ボリューム内の保管中のデータと、ボリュームとクラスターの間を移動するデータの両方について、ホストのルートボリュームを暗号化するかどうかを示すフラグ。 クラスターでは、この設定は常に有効になっています。
デフォルト値はtrueです。
クラスター階層(デフォルトのストレージとメモリキャパシティー)で、クラスター内のすべてのデータ保持ホストに適用されます。
値は M10、M20、M30、M40、M50、M60、M80、M100、M140、M200、M300、R40、 R50、R60、R80、R200、R300、R400、R700、M40_NVME、M50_NVME、M60_NVME、M80_NVME、M200_NVME、または M400_NVME。
MongoDB Cloud がAWSでホストされているMongoDBクラスター ノードを配置する物理的なロケーション。選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。MongoDB Cloud は専有クラスターを配置するときに、そのプロバイダーとリージョンにVPCまたはVPC接続が存在するかどうかを確認します。変換できない場合、 MongoDB Cloud は配置の一部としてそれらを作成します。MongoDB Cloud はVPCに CIDR ブロックを割り当てます。新しいVPCピアリング接続を 1 つの CIDR ブロックとリージョンに制限するには、最初に接続を作成します。接続が開始された後にクラスターを配置します。
値は US_GOV_WEST_1、US_GOV_EAST_1、US_EAST_1、US_EAST_2、US_WEST_1、US_WEST_2、CA_CENTRAL_1、EU_NORTH_1、EU_WEST_1、EU_WEST_2、EU_WEST_3、EU_CENTRAL_1、 EU_CENTRAL_2、AP_EAST_1、AP_NORTHEAST_1、AP_NORTHEAST_2、AP_NORTHEAST_3、AP_SOUTHEAST_1、AP_SOUTHEAST_2、AP_SOUTHEAST_3、AP_SOUTHEAST_4、AP_SOUTH_1、AP_SOUTH_2、SA_EAST_1、CN_NORTH_1、CN_NORTHWEST_1、ME_SOUTH_1、ME_CENTRAL_1、AF_SOUTH_1、EU_SOUTH_1、EU_SOUTH_2、IL_CENTRAL_1、CA_WEST_1、AP_SOUTHEAST_5、AP_SOUTHEAST_7、MX_CENTRAL_1、または GLOBAL 。
Amazon Web Services ( Amazon Web Services )ストレージの 1 秒あたりのディスク入力および出力操作数(IOPS)Amazon Web Services。 1 秒あたりのディスク入力/出力操作数(IOPS)が、選択したボリューム サイズ(STANDARD)のデフォルトの入力/出力操作数(IOPS)を超えませんか、または 1 秒あたりの許容入力操作数内に収まる必要があるかを指定します。選択したボリューム サイズの (IOPS)範囲(PROVISIONED)。NVMe クラスターの場合、この値を (PROVISIONED)に設定する必要があります。
値は STANDARD または PROVISIONED です。
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
値は AZURE です。
クラスターを増やすことができるインスタンス サイズの範囲。
クラスターがクラスター層を増やす方法と、クラスターが増やすダウンできるかどうかを構成する設定のコレクション。低 CPU または NVMEストレージクラスを使用するクラスターでは、クラスター階層のオートスケーリングは使用できません。
クラスターがオート増やすできる最大インスタンスサイズ
値は M10、M20、M30、M40、M50、M60、M80、M90、M200、R40、R50、R60、 R80、R200、R300、R400、M60_NVME、M80_NVME、M200_NVME、M300_NVME、M400_NVME、または M600_NVME 。
クラスターが オート増やすできる最小インスタンスサイズ。
値は M10、M20、M30、M40、M50、M60、M80、M90、M200、R40、R50、R60、 R80、R200、R300、R400、M60_NVME、M80_NVME、M200_NVME、M300_NVME、M400_NVME、または M600_NVME 。
Azureインスタンスのホストのルート ボリュームに対応するディスクの種類。省略した場合、選択した providerSettings.instanceSizeName のデフォルトのディスク タイプが適用されます。
値は、P2、P3、P4、P6、P10、P15、P20、P30、P40、または P50 です。
クラスター階層(デフォルトのストレージとメモリキャパシティー)で、クラスター内のすべてのデータ保持ホストに適用されます。
値は M10、M20、M30、M40、M50、M60、M80、M90、M200、R40、R50、R60、 R80、R200、R300、R400、M60_NVME、M80_NVME、M200_NVME、M300_NVME、M400_NVME、または M600_NVME 。
Microsoft Azureリージョン。
値は US_CENTRAL、US_EAST、US_EAST_2、US_NORTH_CENTRAL、US_WEST、US_SOUTH_CENTRAL、EUROPE_NORTH、EUROPE_WEST、US_WEST_CENTRAL、US_WEST_2、US_WEST_3、CANADA_EAST、 CANADA_CENTRAL、BRAZIL_SOUTH、BRAZIL_SOUTHEAST、AUSTRALIA_CENTRAL、AUSTRALIA_CENTRAL_2、AUSTRALIA_EAST、AUSTRALIA_SOUTH_EAST、GERMANY_WEST_CENTRAL、GERMANY_NORTH、SWEDEN_CENTRAL、SWEDEN_SOUTH、SWITZERLAND_NORTH、SWITZERLAND_WEST、UK_SOUTH、UK_WEST、NORWAY_EAST、NORWAY_WEST、INDIA_CENTRAL、INDIA_SOUTH、INDIA_WEST、CHINA_EAST、CHINA_NORTH、ASIA_EAST、JAPAN_EAST、JAPAN_WEST、 ASIA_SOUTH_EAST、KOREA_CENTRAL、KOREA_SOUTH、FRANCE_CENTRAL、FRANCE_SOUTH、SOUTH_AFRICA_NORTH、SOUTH_AFRICA_WEST、UAE_CENTRAL、UAE_NORTH、QATAR_CENTRAL、POLAND_CENTRAL、ISRAEL_CENTRAL、ITALY_NORTH、SPAIN_CENTRAL、MEXICO_CENTRAL、または NEW_ZEALAND_NORTH のいずれか)。
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
値は GCP です。
クラスターを増やすことができるインスタンス サイズの範囲。
クラスターがクラスター層を増やす方法と、クラスターが増やすダウンできるかどうかを構成する設定のコレクション。低 CPU または NVMEストレージクラスを使用するクラスターでは、クラスター階層のオートスケーリングは使用できません。
クラスター階層(デフォルトのストレージとメモリキャパシティー)で、クラスター内のすべてのデータ保持ホストに適用されます。
値は M10、M20、M30、M40、M50、M60、M80、M140、M200、M250、M300、M400、 R40、R50、R60、R80、R200、R300、R400、または R600
Google compute リージョン。
値は EASTERN_US、EASTERN_US_AW、US_EAST_4、US_EAST_4_AW、US_EAST_5、US_EAST_5_AW、US_WEST_2、US_WEST_2_AW、US_WEST_3、US_WEST_3_AW、US_WEST_4、US_WEST_4_AW、 US_SOUTH_1、US_SOUTH_1_AW、CENTRAL_US、CENTRAL_US_AW、WESTERN_US、WESTERN_US_AW、NORTH_AMERICA_NORTHEAST_1、NORTH_AMERICA_NORTHEAST_2、NORTH_AMERICA_SOUTH_1、SOUTH_AMERICA_EAST_1、SOUTH_AMERICA_WEST_1、WESTERN_EUROPE、EUROPE_NORTH_1、EUROPE_WEST_2、EUROPE_WEST_3、EUROPE_WEST_4、EUROPE_WEST_6、EUROPE_WEST_8、EUROPE_WEST_9、EUROPE_WEST_10、EUROPE_WEST_12、EUROPE_SOUTHWEST_1、EUROPE_CENTRAL_2、MIDDLE_EAST_CENTRAL_1、MIDDLE_EAST_CENTRAL_2、 MIDDLE_EAST_WEST_1、AUSTRALIA_SOUTHEAST_1、AUSTRALIA_SOUTHEAST_2、AFRICA_SOUTH_1、EASTERN_ASIA_PACIFIC、NORTHEASTERN_ASIA_PACIFIC、SOUTHEASTERN_ASIA_PACIFIC、ASIA_EAST_2、ASIA_NORTHEAST_2、ASIA_NORTHEAST_3、ASIA_SOUTH_1、ASIA_SOUTH_2、または ASIA_SOUTHEAST_2
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
値は TENANT です。
クラスターを増やすことができるインスタンス サイズの範囲。
MongoDB Cloud がマルチテナント ホストをプロビジョニングしたクラウド サービス プロバイダー。 providerSettings.providerName がTENANT であり、 providerSetting.instanceSizeName がM0 、 、または の場合、リソースはこのパラメータを返します。M2M5
M2 または M5 の instanceSize を使用すると、代わりに Flex クラスターが作成されることにご注意ください。M2または M5 の instanceSize のサポートは、2026 年 1 月に終了します。今後、このような構成には createFlexCluster API を使用することをお勧めします。
値は AWS、GCP、または AZURE です。
クラスター階層(デフォルトのストレージとメモリキャパシティー)で、クラスター内のすべてのデータ保持ホストに適用されます。 providerSettings.providerName を に設定し、TENANT providerSettings.backingProviderName でクラウドサービス プロバイダーを指定する必要があります。
値は M0、M2、または M5 です。
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
値は FLEX です。
MongoDB Cloud がマルチテナント ホストをプロビジョニングしたクラウド サービス プロバイダー。 providerSettings.providerName がFLEX で、 providerSetting.instanceSizeName がFLEX の場合、リソースはこのパラメータを返します。
値は AWS、GCP、または AZURE です。
クラスター階層(デフォルトのストレージとメモリキャパシティー)で、クラスター内のすべてのデータ保持ホストに適用されます。 providerSettings.providerName を に設定し、FLEX providerSettings.backingProviderName でクラウドサービス プロバイダーを指定する必要があります。
値は FLEX です。
クラスターのレプリカセット スケーリング モードを構成するには、このフィールドを に設定します。
デフォルトでは、Atlas は WORKLOAD_Type の下でスケーリングされます。 このモードでは、Atlas は分析ノードを運用ノードと並行して拡張できます。
SEQUENTIAL として構成すると、Atlas はすべてのノードを順番にスケーリングします。 このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。
Node_type として構成すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。 このモードは、頻繁にクラスター階層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。 これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響を与える可能性があります。
値は SEQUENTIAL、WORKLOAD_TYPE、または NODE_TYPE です。デフォルト値は WORKLOAD_TYPE です。
レプリカセットに属するノードの数。各ノードはデータベースのコピーを保持し、高可用性とデータの冗長性を提供します。代わりに replicationSpecs を使用してください。
値は 3、5、または 7 です。デフォルト値は 3 です。
MongoDB Cloud がクラスター ノードをプロビジョニングする物理的なロケーション。
MongoDB Cloud がクラスター ノードをプロビジョニングする物理的なロケーション。
リージョン内の分析ノードの数。分析ノードは、 MongoDB Cloud 上のMongoDB Connector for Business Intelligence からのクエリのレポートなどの分析データを処理します。分析ノードは読み取り専用であり、プライマリになることはできません。代わりに replicationSpecs[n].{region}.analyticsNodes を使用してください。
指定されたリージョンに配置する選択可能なノードの数。選択可能なノードはプライマリになることができ、ローカル読み取りが容易になります。replicationSpecs[n].{region}.electableNodes の使用ください。
値は、0、3、5、または 7 です。
リージョンの選挙の優先順位を示す数値。クラスターの使用リージョンを識別するには、このパラメーターを7 に設定します。プライマリノードは優先リージョン で実行されます。読み取り専用リージョンを識別するには、このパラメータを0 に設定します。
最小値は 0、最大値は 7 です。
リージョン内の読み取り専用ノードの数。読み取り専用ノードは プライマリ ノードになることはできませんが、ローカル読み取りを容易にできます。replicationSpecs[n].{region}.readOnlyNodes を使用するください。
クラスター リージョンを構成する設定のリスト。
グローバルクラスター内のゾーンのレプリケーションオブジェクトを識別する一意な 24 桁の 16 進数文字列。
リクエストに既存の ゾーン を含める場合は、このパラメーターを指定する必要があります。
既存のグローバルクラスターに新しいゾーンを追加する場合は、このパラメーターを指定できます。リクエストは、リクエストから除外したグローバルクラスター内の既存のゾーンを削除します。
形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
指定された各ゾーンに配置するシャードの数を指定する正の整数。この値を に設定し、 clusterType が の場合、1 MongoDB Cloud は単一シャードのシャーディングされたクラスターを配置します。実稼働環境では、単一のシャードを含むシャーディングされたクラスターを作成しないでください。単一シャードのシャード クラスターでは、マルチシャード構成と同じ利点は得られません。SHARDED
レプリカセットをシャーディングされたクラスターにアップグレードする場合、同じ 更新リクエストでシャードの数を増やすことはできません。クラスターがシャーディングへのアップグレードを完了し、すべてのアプリケーションクライアントをMongoDBルーターに再接続してから、追加のシャードを追加する必要があります。そうしないと、 MongoDB Cloud によってシャード間でのデータ分散が開始された後、データの整合性が失われる可能性があります。
デフォルト値は1です。
MongoDB Cloud がクラスター ノードをプロビジョニングする物理的なロケーション。
MongoDB Cloud がクラスター ノードをプロビジョニングする物理的なロケーション。
リージョン内の分析ノードの数。分析ノードは、 MongoDB Cloud 上のMongoDB Connector for Business Intelligence からのクエリのレポートなどの分析データを処理します。分析ノードは読み取り専用であり、プライマリになることはできません。代わりに replicationSpecs[n].{region}.analyticsNodes を使用してください。
指定されたリージョンに配置する選択可能なノードの数。選択可能なノードはプライマリになることができ、ローカル読み取りが容易になります。replicationSpecs[n].{region}.electableNodes の使用ください。
値は、0、3、5、または 7 です。
リージョンの選挙の優先順位を示す数値。クラスターの使用リージョンを識別するには、このパラメーターを7 に設定します。プライマリノードは優先リージョン で実行されます。読み取り専用リージョンを識別するには、このパラメータを0 に設定します。
最小値は 0、最大値は 7 です。
リージョン内の読み取り専用ノードの数。読み取り専用ノードは プライマリ ノードになることはできませんが、ローカル読み取りを容易にできます。replicationSpecs[n].{region}.readOnlyNodes を使用するください。
グローバルクラスター内のゾーンを識別する、人間が判読できるラベル。この値は、 clusterType がGEOSHARDED の場合にのみ指定します。
MongoDB Atlasクラスターが使用するルート認証局。 MongoDB Cloud は Internet Security Research Group をサポートしています。
値は ISRGROOTX1 です。デフォルト値は ISRGROOTX1 です。
クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。
MongoDB Cloud の組織、プロジェクト、または クラスター をタグ付けして分類するキーと値のペア。例、environment : production。
クラスターで終了保護が有効になっているかどうかを示すフラグ。true に設定されていると、MongoDB Cloud はクラスターを削除しません。false に設定されていると、MongoDB Cloud はクラスターを削除します。
デフォルト値はfalseです。
クラスターが MongoDB のバージョンを管理する方法。値が CONTINUOUS の場合、mongoDBMajorVersion を指定しないでください。
値は LTS または CONTINUOUS です。デフォルト値は LTS です。
OK
リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み(過半数がコミットされた書込みであっても)が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。 このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
高度な構成の詳細のサブセットを構成する設定のグループ。
TLS 1.2 のカスタム OpenSSL 暗号スイート リスト。 このフィールドは、tlsCipherConfigMode が CUSTOM に設定されている場合にのみ有効です。
値は TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 または TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 です。
クラスターが受信接続に受け入れる TLS(Transport Layer Security)の最小バージョン。TLS 1.0 または 1.1 を使用するクラスターでは、TLS プロトコルの最小バージョンとして TLS 1.2 を設定することを検討する必要があります。
値は TLS1_0、TLS1_1、または TLS1_2 です。
TLS 暗号スイートの 構成モード。 デフォルトモードでは、デフォルトの暗号スイートが使用されます。 カスタムモードでは、 TLS 1.2 と TLS 1.3 の両方のカスタム暗号スイートを指定できます。
値は CUSTOM または DEFAULT です。
クラスターを増やすことができるインスタンス サイズの範囲。
クラスターがクラスター層を増やす方法と、クラスターが増やすダウンできるかどうかを構成する設定のコレクション。低 CPU または NVMEストレージクラスを使用するクラスターでは、クラスター階層のオートスケーリングは使用できません。
インスタンスサイズのリアクティブなオートスケーリングが有効になっているかどうかを示すフラグ。
trueインスタンスサイズのリアクティブなオートスケーリングを有効にするには、 に設定します。有効にする場合は、 providerSettings.autoScaling.compute.maxInstanceSize の値を指定する必要があります。false に設定します。デフォルト値はfalseです。
予測インスタンスサイズのオートスケーリングが有効になっているかどうかを示すフラグ。
true予測インスタンスサイズのオートスケーリングを有効にするには、 に設定します。この機能を有効にするには、 MongoDBが trueである必要があります。false に設定します。デフォルト値はfalseです。
リアクティブなオートスケーリングによってクラスター層を増やすダウンできるかどうかを示すフラグ。 autoScaling.compute.enabled が の場合は、これが必要です。このオプションを有効にする場合は、true providerSettings.autoScaling.compute.minInstanceSize の値を指定します。
デフォルト値はfalseです。
このクラスターでディスクのオートスケーリングが有効になっているかどうかを示すフラグ。
デフォルト値はfalseです。
クラスターがバックアップを実行できるかどうかを示すフラグ。true に設定されていると、クラスターはバックアップを実行できます。NVMe クラスターの場合、この値を true に設定する必要があります。バックアップは、専用クラスターにはクラウドバックアップを使用し、テナントクラスターには共有クラスターバックアップを使用します。false に設定されていると、クラスターは MongoDB Cloud バックアップを使用しません。
このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。
MongoDB Connector for Business Intelligence が指定されたクラスターで有効になっているかどうかを示すフラグ。
MongoDB Cloud 上のMongoDB Connector for Business Intelligence に指定されたデータソースノード。 MongoDB Cloud 上のMongoDB Connector for Business Intelligence は、 読み込み設定(read preference) に基づいて、プライマリ、セカンダリ、または分析ノードからデータを読み取ります。デフォルトは ANALYTICSノード、または ANALYTICS ノードがない場合は SECONDARY になります。
値は PRIMARY、SECONDARY、または ANALYTICS です。
クラスターを構成するノードの構成。
値は REPLICASET、SHARDED、または GEOSHARDED です。
シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバー マネジメント モード。
ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスとコスト削減のために、クラスターのコンフィギュレーションサーバーの種類を自動的に切り替える場合があります。
FIXED_TO_DEDICATED として構成すると、クラスターは常に専用のコンフィギュレーションサーバーを使用します。
値は ATLAS_MANAGED または FIXED_TO_DEDICATED です。デフォルト値は ATLAS_MANAGED です。
シャーディングされたクラスターのコンフィギュレーションサーバーのタイプを説明します。
値は DEDICATED または EMBEDDED です。
MongoDB データベースを指すユニフォーム リソース ロケータのコレクション。
Amazon Web Services (AWS ) PrivateLink でホストされるAWSホスト型クラスターを使用する、プライベートエンドポイント対応の接続文字列。各キーはAmazon Web Services (AWS)のインターフェイスエンドポイントを識別します。各値は、キーが名前を付けるインターフェイスエンドポイントを介してMongoDB Cloud に接続するために使用する関連する mongodb://接続文字列を識別します。
Amazon Web Services (AWS ) PrivateLink でホストされるAWSホスト型クラスターを使用する、プライベートエンドポイント対応の接続文字列。各キーはAmazon Web Services (AWS)のインターフェイスエンドポイントを識別します。各値は、キーが名前を付けるインターフェイスエンドポイントを介してMongoDB Cloud に接続するために使用する関連する mongodb://接続文字列を識別します。
Amazon Web Services (AWS ) PrivateLink でホストされるAWSホスト型クラスターを使用する、プライベートエンドポイント対応の接続文字列。各キーはAmazon Web Services (AWS)のインターフェイスエンドポイントを識別します。各値は、キーが名前を付けるインターフェイスエンドポイントを介してmongodb:// Atlas に接続するために使用する関連する 接続文字列を識別します。クラスターがawsPrivateLinkSrv 最適化された接続文字列を使用する場合、awsPrivateLinkSrv には最適化された接続文字列が含まれます。クラスターに最適化されていない(レガシー)接続文字列がある場合、最適化された接続文字列が含まれます。
Amazon Web Services (AWS ) PrivateLink でホストされるAWSホスト型クラスターを使用する、プライベートエンドポイント対応の接続文字列。各キーはAmazon Web Services (AWS)のインターフェイスエンドポイントを識別します。各値は、キーが名前を付けるインターフェイスエンドポイントを介してmongodb:// Atlas に接続するために使用する関連する 接続文字列を識別します。クラスターがawsPrivateLinkSrv 最適化された接続文字列を使用する場合、awsPrivateLinkSrv には最適化された接続文字列が含まれます。クラスターに最適化されていない(レガシー)接続文字列がある場合、最適化された接続文字列が含まれます。
このクラスターに接続するために構成した各インターフェースの仮想プライベートクラウド(VPC)エンドポイントのネットワークピアリング接続文字列。この接続文字列はmongodb+srv://プロトコルを使用します。リソースは、このクラスターへのネットワークピアリング接続がユーザーが作成すると、このパラメーターを返します。このプロトコルは、アプリケーションにDNS(Domain Name System)でホストシードリストを検索するように指示します。このリストは、クラスター内のノードと同期します。接続文字列がこの URI(Uniform Resource Identifier)形式を使用している場合、ノードが変更された場合にシードリストを追加したり、URI を変更したりする必要はありません。ドライバーが URI 形式をサポートしている場合は、この URI形式を使用します 。そうでない場合は、 connectionStrings.private を使用します。 Amazon Web Services (AWS)クラスターの場合、このリソースはカスタム DNS を有効にしている場合にのみこのパラメーターを返します。
プライベートエンドポイント経由でこのクラスターに接続するために使用できるプライベートエンドポイント対応接続文字列のリスト。このパラメーターは、このクラスターのノードを配置したすべてのリージョンにプライベートエンドポイントを配置した場合にのみ を返します。
プライベートエンドポイントを認識する接続文字列。プライベートエンドポイントを介してこのクラスターに接続するために使用できます。
プライベートエンドポイントを認識する接続文字列。mongodb://プロトコルを使用し、プライベートエンドポイントを介してMongoDB Cloud に接続します。
connectionStrings.privateEndpoint[n]. connectionString または connectionStrings.privateEndpoint[n].srvConnectionString を使用するときにMongoDB Cloud に接続するプライベートエンドポイントを含むリスト。
このクラスターに配置されたプライベートエンドポイントの詳細。
プライベートエンドポイントを認識する接続文字列。mongodb+srv://プロトコルを使用し、プライベートエンドポイントを介してMongoDB Cloud に接続します。 mongodb+srvプロトコルは、Domain Name System(DNS)内のホストのシードリストを検索するようにドライバーに指示します。このリストは、クラスター内のノードと同期します。接続文字列がこの URI(Uniform Resource Identifier)形式を使用している場合、ノードが変更された場合にシードリストを追加したり、Uniform Resource Identifier(URI)を変更したりする必要はありません。アプリケーションがURI(Uniform Resource Identifier)をサポートしている場合は、この URI(Uniform Resource Identifier)形式を使用します 。そうでない場合は、 connectionStrings.privateEndpoint[n]. connectionString を使用します。
シャーディングされたクラスター用に最適化されたプライベートエンドポイント対応の接続文字列。mongodb+srv://プロトコルを使用してプライベートエンドポイント経由でMongoDB Cloud に接続します。接続文字列がこの URI(Uniform Resource Identifier)形式を使用している場合、ノードが変更された場合に URI(Uniform Resource Identifier)を変更する必要はありません。アプリケーションと Atlas クラスターが URI(Uniform Resource Identifier)をサポートしている場合は、この URI(Uniform Resource Identifier)形式を使用します 。含まれない場合は、 connectionStrings.privateEndpoint[n].srvConnectionString を使用してドキュメントを参照してください。
アプリケーションが接続するMongoDBプロセス タイプ。レプリカセットには MONGOD を使用し、シャーディングされたクラスターには MONGOS を使用します。
値は MONGOD または MONGOS です。
このクラスターに接続するために構成した各インターフェースの仮想プライベートクラウド(VPC)エンドポイントのネットワークピアリング接続文字列。この接続文字列はmongodb+srv:// プロトコルを使用します。リソースは、このクラスターへのネットワークピアリング接続が誰かが作成したときに、このパラメータを返します。このプロトコルは、アプリケーションにDNS(Domain Name System)でホストシードリストを検索するように指示します。このリストは、クラスター内のノードと同期します。接続文字列がこの URI(Uniform Resource Identifier)形式を使用している場合、ノードが変更された場合にシードリストを追加したり、Uniform Resource Identifier(URI)を変更したりする必要はありません。ドライバーが URI(Uniform Resource Identifier) をサポートしている場合は、この URI(Uniform Resource Identifier)形式を使用します。問題が発生しない場合は、connectionStrings.private を使用します。 Amazon Web Services (AWS)クラスターの場合、このパラメーターはカスタム DNS を有効にしている場合にのみ返します。
このクラスターに接続するために使用できるパブリック接続文字列。この接続文字列はmongodb://プロトコルを使用します。
このクラスターに接続するために使用できるパブリック接続文字列。この接続文字列はmongodb+srv://プロトコルを使用します。
MongoDB Cloud がこのサーバーレスインスタンスを作成した日時。MongoDB Cloud は、このタイムスタンプを UTC の ISO 8601形式で表します。
インスタンス データ ボリュームのストレージ容量(ギガバイト単位)。 この数を増やすと、容量が追加されます。
この値は、M 0 /M 2 /M 5クラスターでは構成できません。
MongoDB Cloud では、replicationSpecs を設定する場合にこのパラメータが必要です。
最小( 10 GB)より小さいディスク サイズを指定する場合、このパラメータはデフォルトで最小ディスク サイズ値になります。
ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。
ディスク ストレージの最大値は、選択したクラスターの最大 RAM の50倍を超えることはできません。 より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。
最小値は 10、最大値は 4096 です。
ディスク ウォーミング モードの選択。
値は FULLY_WARMED または VISIBLE_EARLIER です。デフォルト値は FULLY_WARMED です。
カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。保管時の暗号化のためのカスタマー キー管理を有効にするには、クラスター eplicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize の設定は、M10 以上、かつ "backupEnabled" : false または完全に省略する必要があります。
値は、NONE、AWS、AZURE、または GCP です。
クラスターの機能の互換性バージョン。
機能の互換性バージョンの有効期限。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。
false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。
true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。
この設定は、クラスターが配置されると変更できません。
プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。
形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
クラスターを識別するユニークな 24 桁の 16 進数の文字列。
形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。
クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めします。
このMongoDB Cloud コンポーネントに適用された、人間が判読可能なラベル。
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator(URL)のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
MongoDB 従業員に付与されるクラスターのアクセスレベルと有効期限。
従業員アクセス権の有効期限。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
MongoDB 従業員に付与するアクセス権のレベル。
値は CLUSTER_DATABASE_LOGS、CLUSTER_INFRASTRUCTURE、または CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA です。
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator(URL)のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
クラスターの MongoDB メジャー バージョン。
作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョン エンドポイントの API エンドポイントを使用してください。
更新時: 一度に1メジャー バージョンを つだけ上げてください。 クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。
クラスターが実行する MongoDB のバージョン。
形式は次のパターンと一致する必要があります: ([\d]+\.[\d]+\.[\d]+)。
クラスターに接続するために使用できる 基本接続文字列。 MongoDB Cloud では、クラスターのビルド中ではなく、クラスターの起動後にのみ string が表示されます。
接続文字列 が誰かが最後に更新された日時。 MongoDB Cloud は、このタイムスタンプを UTC の ISO 8601形式で表します。
クラスターに接続するために使用できる 接続文字列 には、クラスターに適した値を持つ replicaSet、ssl、authSource クエリ パラメータが含まれます。 MongoDBデータベースユーザーを追加する必要がある場合があります。レスポンスは、クラスターの構築中ではなく、クラスターがリクエストを受信できると返します。
クラスターを識別する人間が判読できるラベル。
形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$。
シャーディングされたクラスターに配置できるシャードの数は最大 50 個です。リソースは、レプリカセットを示す場合は 1 を返し、シャーディングされたクラスターを示す場合は 2 以上の値を返します。戻り値は、クラスター内のシャードの数と等しくなります。
最小値は 1、最大値は 50 です。デフォルト値は 1 です。
クラスターが一時停止しているかどうかを示すフラグ。
クラスターが継続的なクラウドバックアップを使用するかどうかを示すフラグ。
M10 以上のクラスターがクラウドバックアップを実行できるかどうかを示すフラグ。true に設定されていると、クラスターはバックアップを実行できます。これと backupEnabled が false に設定されている場合、クラスターは MongoDB Cloud バックアップを使用しません。
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
値は AWS です。
クラスターを増やすことができるインスタンス サイズの範囲。
クラスターがクラスター層を増やす方法と、クラスターが増やすダウンできるかどうかを構成する設定のコレクション。低 CPU または NVMEストレージクラスを使用するクラスターでは、クラスター階層のオートスケーリングは使用できません。
クラスターがオート増やすできる最大インスタンスサイズ
値は M10、M20、M30、M40、M50、M60、M80、M100、M140、M200、M300、R40、 R50、R60、R80、R200、R300、R400、R700、M40_NVME、M50_NVME、M60_NVME、M80_NVME、M200_NVME、または M400_NVME。
クラスターが オート増やすできる最小インスタンスサイズ。
値は M10、M20、M30、M40、M50、M60、M80、M100、M140、M200、M300、R40、 R50、R60、R80、R200、R300、R400、R700、M40_NVME、M50_NVME、M60_NVME、M80_NVME、M200_NVME、または M400_NVME。
データベースホストが実行できる 1 秒あたりの最大ディスク入力/出力操作数(IOPS)。
EBS( Amazon Elastic Block Store)暗号化機能が、ボリューム内の保管中のデータと、ボリュームとクラスターの間を移動するデータの両方について、ホストのルートボリュームを暗号化するかどうかを示すフラグ。 クラスターでは、この設定は常に有効になっています。
デフォルト値はtrueです。
クラスター階層(デフォルトのストレージとメモリキャパシティー)で、クラスター内のすべてのデータ保持ホストに適用されます。
値は M10、M20、M30、M40、M50、M60、M80、M100、M140、M200、M300、R40、 R50、R60、R80、R200、R300、R400、R700、M40_NVME、M50_NVME、M60_NVME、M80_NVME、M200_NVME、または M400_NVME。
MongoDB Cloud がAWSでホストされているMongoDBクラスター ノードを配置する物理的なロケーション。選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。MongoDB Cloud は専有クラスターを配置するときに、そのプロバイダーとリージョンにVPCまたはVPC接続が存在するかどうかを確認します。変換できない場合、 MongoDB Cloud は配置の一部としてそれらを作成します。MongoDB Cloud はVPCに CIDR ブロックを割り当てます。新しいVPCピアリング接続を 1 つの CIDR ブロックとリージョンに制限するには、最初に接続を作成します。接続が開始された後にクラスターを配置します。
値は US_GOV_WEST_1、US_GOV_EAST_1、US_EAST_1、US_EAST_2、US_WEST_1、US_WEST_2、CA_CENTRAL_1、EU_NORTH_1、EU_WEST_1、EU_WEST_2、EU_WEST_3、EU_CENTRAL_1、 EU_CENTRAL_2、AP_EAST_1、AP_NORTHEAST_1、AP_NORTHEAST_2、AP_NORTHEAST_3、AP_SOUTHEAST_1、AP_SOUTHEAST_2、AP_SOUTHEAST_3、AP_SOUTHEAST_4、AP_SOUTH_1、AP_SOUTH_2、SA_EAST_1、CN_NORTH_1、CN_NORTHWEST_1、ME_SOUTH_1、ME_CENTRAL_1、AF_SOUTH_1、EU_SOUTH_1、EU_SOUTH_2、IL_CENTRAL_1、CA_WEST_1、AP_SOUTHEAST_5、AP_SOUTHEAST_7、MX_CENTRAL_1、または GLOBAL 。
Amazon Web Services ( Amazon Web Services )ストレージの 1 秒あたりのディスク入力および出力操作数(IOPS)Amazon Web Services。 1 秒あたりのディスク入力/出力操作数(IOPS)が、選択したボリューム サイズ(STANDARD)のデフォルトの入力/出力操作数(IOPS)を超えませんか、または 1 秒あたりの許容入力操作数内に収まる必要があるかを指定します。選択したボリューム サイズの (IOPS)範囲(PROVISIONED)。NVMe クラスターの場合、この値を (PROVISIONED)に設定する必要があります。
値は STANDARD または PROVISIONED です。
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
値は AZURE です。
クラスターを増やすことができるインスタンス サイズの範囲。
クラスターがクラスター層を増やす方法と、クラスターが増やすダウンできるかどうかを構成する設定のコレクション。低 CPU または NVMEストレージクラスを使用するクラスターでは、クラスター階層のオートスケーリングは使用できません。
クラスターがオート増やすできる最大インスタンスサイズ
値は M10、M20、M30、M40、M50、M60、M80、M90、M200、R40、R50、R60、 R80、R200、R300、R400、M60_NVME、M80_NVME、M200_NVME、M300_NVME、M400_NVME、または M600_NVME 。
クラスターが オート増やすできる最小インスタンスサイズ。
値は M10、M20、M30、M40、M50、M60、M80、M90、M200、R40、R50、R60、 R80、R200、R300、R400、M60_NVME、M80_NVME、M200_NVME、M300_NVME、M400_NVME、または M600_NVME 。
Azureインスタンスのホストのルート ボリュームに対応するディスクの種類。省略した場合、選択した providerSettings.instanceSizeName のデフォルトのディスク タイプが適用されます。
値は、P2、P3、P4、P6、P10、P15、P20、P30、P40、または P50 です。
クラスター階層(デフォルトのストレージとメモリキャパシティー)で、クラスター内のすべてのデータ保持ホストに適用されます。
値は M10、M20、M30、M40、M50、M60、M80、M90、M200、R40、R50、R60、 R80、R200、R300、R400、M60_NVME、M80_NVME、M200_NVME、M300_NVME、M400_NVME、または M600_NVME 。
Microsoft Azureリージョン。
値は US_CENTRAL、US_EAST、US_EAST_2、US_NORTH_CENTRAL、US_WEST、US_SOUTH_CENTRAL、EUROPE_NORTH、EUROPE_WEST、US_WEST_CENTRAL、US_WEST_2、US_WEST_3、CANADA_EAST、 CANADA_CENTRAL、BRAZIL_SOUTH、BRAZIL_SOUTHEAST、AUSTRALIA_CENTRAL、AUSTRALIA_CENTRAL_2、AUSTRALIA_EAST、AUSTRALIA_SOUTH_EAST、GERMANY_WEST_CENTRAL、GERMANY_NORTH、SWEDEN_CENTRAL、SWEDEN_SOUTH、SWITZERLAND_NORTH、SWITZERLAND_WEST、UK_SOUTH、UK_WEST、NORWAY_EAST、NORWAY_WEST、INDIA_CENTRAL、INDIA_SOUTH、INDIA_WEST、CHINA_EAST、CHINA_NORTH、ASIA_EAST、JAPAN_EAST、JAPAN_WEST、 ASIA_SOUTH_EAST、KOREA_CENTRAL、KOREA_SOUTH、FRANCE_CENTRAL、FRANCE_SOUTH、SOUTH_AFRICA_NORTH、SOUTH_AFRICA_WEST、UAE_CENTRAL、UAE_NORTH、QATAR_CENTRAL、POLAND_CENTRAL、ISRAEL_CENTRAL、ITALY_NORTH、SPAIN_CENTRAL、MEXICO_CENTRAL、または NEW_ZEALAND_NORTH のいずれか)。
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
値は GCP です。
クラスターを増やすことができるインスタンス サイズの範囲。
クラスターがクラスター層を増やす方法と、クラスターが増やすダウンできるかどうかを構成する設定のコレクション。低 CPU または NVMEストレージクラスを使用するクラスターでは、クラスター階層のオートスケーリングは使用できません。
クラスター階層(デフォルトのストレージとメモリキャパシティー)で、クラスター内のすべてのデータ保持ホストに適用されます。
値は M10、M20、M30、M40、M50、M60、M80、M140、M200、M250、M300、M400、 R40、R50、R60、R80、R200、R300、R400、または R600
Google compute リージョン。
値は EASTERN_US、EASTERN_US_AW、US_EAST_4、US_EAST_4_AW、US_EAST_5、US_EAST_5_AW、US_WEST_2、US_WEST_2_AW、US_WEST_3、US_WEST_3_AW、US_WEST_4、US_WEST_4_AW、 US_SOUTH_1、US_SOUTH_1_AW、CENTRAL_US、CENTRAL_US_AW、WESTERN_US、WESTERN_US_AW、NORTH_AMERICA_NORTHEAST_1、NORTH_AMERICA_NORTHEAST_2、NORTH_AMERICA_SOUTH_1、SOUTH_AMERICA_EAST_1、SOUTH_AMERICA_WEST_1、WESTERN_EUROPE、EUROPE_NORTH_1、EUROPE_WEST_2、EUROPE_WEST_3、EUROPE_WEST_4、EUROPE_WEST_6、EUROPE_WEST_8、EUROPE_WEST_9、EUROPE_WEST_10、EUROPE_WEST_12、EUROPE_SOUTHWEST_1、EUROPE_CENTRAL_2、MIDDLE_EAST_CENTRAL_1、MIDDLE_EAST_CENTRAL_2、 MIDDLE_EAST_WEST_1、AUSTRALIA_SOUTHEAST_1、AUSTRALIA_SOUTHEAST_2、AFRICA_SOUTH_1、EASTERN_ASIA_PACIFIC、NORTHEASTERN_ASIA_PACIFIC、SOUTHEASTERN_ASIA_PACIFIC、ASIA_EAST_2、ASIA_NORTHEAST_2、ASIA_NORTHEAST_3、ASIA_SOUTH_1、ASIA_SOUTH_2、または ASIA_SOUTHEAST_2
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
値は TENANT です。
クラスターを増やすことができるインスタンス サイズの範囲。
MongoDB Cloud がマルチテナント ホストをプロビジョニングしたクラウド サービス プロバイダー。 providerSettings.providerName がTENANT であり、 providerSetting.instanceSizeName がM0 、 、または の場合、リソースはこのパラメータを返します。M2M5
M2 または M5 の instanceSize を使用すると、代わりに Flex クラスターが作成されることにご注意ください。M2または M5 の instanceSize のサポートは、2026 年 1 月に終了します。今後、このような構成には createFlexCluster API を使用することをお勧めします。
値は AWS、GCP、または AZURE です。
クラスター階層(デフォルトのストレージとメモリキャパシティー)で、クラスター内のすべてのデータ保持ホストに適用されます。 providerSettings.providerName を に設定し、TENANT providerSettings.backingProviderName でクラウドサービス プロバイダーを指定する必要があります。
値は M0、M2、または M5 です。
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
値は FLEX です。
MongoDB Cloud がマルチテナント ホストをプロビジョニングしたクラウド サービス プロバイダー。 providerSettings.providerName がFLEX で、 providerSetting.instanceSizeName がFLEX の場合、リソースはこのパラメータを返します。
値は AWS、GCP、または AZURE です。
クラスター階層(デフォルトのストレージとメモリキャパシティー)で、クラスター内のすべてのデータ保持ホストに適用されます。 providerSettings.providerName を に設定し、FLEX providerSettings.backingProviderName でクラウドサービス プロバイダーを指定する必要があります。
値は FLEX です。
クラスターのレプリカセット スケーリング モードを構成するには、このフィールドを に設定します。
デフォルトでは、Atlas は WORKLOAD_Type の下でスケーリングされます。 このモードでは、Atlas は分析ノードを運用ノードと並行して拡張できます。
SEQUENTIAL として構成すると、Atlas はすべてのノードを順番にスケーリングします。 このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。
Node_type として構成すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。 このモードは、頻繁にクラスター階層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。 これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響を与える可能性があります。
値は SEQUENTIAL、WORKLOAD_TYPE、または NODE_TYPE です。デフォルト値は WORKLOAD_TYPE です。
レプリカセットに属するノードの数。各ノードはデータベースのコピーを保持し、高可用性とデータの冗長性を提供します。代わりに replicationSpecs を使用してください。
値は 3、5、または 7 です。デフォルト値は 3 です。
MongoDB Cloud がクラスター ノードをプロビジョニングする物理的なロケーション。
MongoDB Cloud がクラスター ノードをプロビジョニングする物理的なロケーション。
リージョン内の分析ノードの数。分析ノードは、 MongoDB Cloud 上のMongoDB Connector for Business Intelligence からのクエリのレポートなどの分析データを処理します。分析ノードは読み取り専用であり、プライマリになることはできません。代わりに replicationSpecs[n].{region}.analyticsNodes を使用してください。
指定されたリージョンに配置する選択可能なノードの数。選択可能なノードはプライマリになることができ、ローカル読み取りが容易になります。replicationSpecs[n].{region}.electableNodes の使用ください。
値は、0、3、5、または 7 です。
リージョンの選挙の優先順位を示す数値。クラスターの使用リージョンを識別するには、このパラメーターを7 に設定します。プライマリノードは優先リージョン で実行されます。読み取り専用リージョンを識別するには、このパラメータを0 に設定します。
最小値は 0、最大値は 7 です。
リージョン内の読み取り専用ノードの数。読み取り専用ノードは プライマリ ノードになることはできませんが、ローカル読み取りを容易にできます。replicationSpecs[n].{region}.readOnlyNodes を使用するください。
クラスター リージョンを構成する設定のリスト。
グローバルクラスター内のゾーンのレプリケーションオブジェクトを識別する一意な 24 桁の 16 進数文字列。
リクエストに既存の ゾーン を含める場合は、このパラメーターを指定する必要があります。
既存のグローバルクラスターに新しいゾーンを追加する場合は、このパラメーターを指定できます。リクエストは、リクエストから除外したグローバルクラスター内の既存のゾーンを削除します。
形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
指定された各ゾーンに配置するシャードの数を指定する正の整数。この値を に設定し、 clusterType が の場合、1 MongoDB Cloud は単一シャードのシャーディングされたクラスターを配置します。実稼働環境では、単一のシャードを含むシャーディングされたクラスターを作成しないでください。単一シャードのシャード クラスターでは、マルチシャード構成と同じ利点は得られません。SHARDED
レプリカセットをシャーディングされたクラスターにアップグレードする場合、同じ 更新リクエストでシャードの数を増やすことはできません。クラスターがシャーディングへのアップグレードを完了し、すべてのアプリケーションクライアントをMongoDBルーターに再接続してから、追加のシャードを追加する必要があります。そうしないと、 MongoDB Cloud によってシャード間でのデータ分散が開始された後、データの整合性が失われる可能性があります。
デフォルト値は1です。
MongoDB Cloud がクラスター ノードをプロビジョニングする物理的なロケーション。
MongoDB Cloud がクラスター ノードをプロビジョニングする物理的なロケーション。
リージョン内の分析ノードの数。分析ノードは、 MongoDB Cloud 上のMongoDB Connector for Business Intelligence からのクエリのレポートなどの分析データを処理します。分析ノードは読み取り専用であり、プライマリになることはできません。代わりに replicationSpecs[n].{region}.analyticsNodes を使用してください。
指定されたリージョンに配置する選択可能なノードの数。選択可能なノードはプライマリになることができ、ローカル読み取りが容易になります。replicationSpecs[n].{region}.electableNodes の使用ください。
値は、0、3、5、または 7 です。
リージョンの選挙の優先順位を示す数値。クラスターの使用リージョンを識別するには、このパラメーターを7 に設定します。プライマリノードは優先リージョン で実行されます。読み取り専用リージョンを識別するには、このパラメータを0 に設定します。
最小値は 0、最大値は 7 です。
リージョン内の読み取り専用ノードの数。読み取り専用ノードは プライマリ ノードになることはできませんが、ローカル読み取りを容易にできます。replicationSpecs[n].{region}.readOnlyNodes を使用するください。
グローバルクラスター内のゾーンを識別する、人間が判読できるラベル。この値は、 clusterType がGEOSHARDED の場合にのみ指定します。
MongoDB Atlasクラスターが使用するルート認証局。 MongoDB Cloud は Internet Security Research Group をサポートしています。
値は ISRGROOTX1 です。デフォルト値は ISRGROOTX1 です。
クラスターに接続するために使用できる 接続文字列 。 +srv 修飾子により、接続ではトランスポート層セキュリティ(TLS)が使用されるように強制されます。 mongoURI パラメーターには追加のオプションがあります。
Atlas コントロール プレーンによってこのクラスターで実行されている現在のアクティビティを示す、人間が判読可能なラベル。 CR表現と削除がノードな状態を除く
IDLE: Atlas はこのクラスターに変更を加えず、 UIまたはAPI経由でリクエストされたすべての変更が適用されたと想定できます。CREATING: 初めてプロビジョニングされたクラスターは、接続の準備が整うまで状態が CRUDING を返します。接続を試みる前に、 IPアクセス リストと DB ユーザーが設定されていることを確認します。UPDATING: UI、 API、AutoScaling、またはその他のスケジュールされたアクティビティからリクエストされた変更が実行されています。DELETING: クラスターは削除プロセス中であり、すぐに削除される予定です。REPAIRING: クラスター内の 1 つ以上のノードが Atlas コントロール プレーンによって使用可能に返されています。他のノードは、通常どおりサービスを提供し続ける必要があります。値は、IDLE、CREATING、UPDATING、DELETING、または REPAIRING です。
クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。
MongoDB Cloud の組織、プロジェクト、または クラスター をタグ付けして分類するキーと値のペア。例、environment : production。
クラスターで終了保護が有効になっているかどうかを示すフラグ。true に設定されていると、MongoDB Cloud はクラスターを削除しません。false に設定されていると、MongoDB Cloud はクラスターを削除します。
デフォルト値はfalseです。
クラスターが MongoDB のバージョンを管理する方法。値が CONTINUOUS の場合、mongoDBMajorVersion を指定しないでください。
値は LTS または CONTINUOUS です。デフォルト値は LTS です。
無効なリクエストです。
無効なリクエストの詳細。
各タイプのエラーの原因となる特定の条件または理由について説明します。
このエラーで返された HTTP ステータス コード。
このエラーで返されたアプリケーション エラー コード。
エラーに関する詳細情報を提供するために使用されるパラメーター。
このエラーで返されたアプリケーション エラー メッセージ。
許可されていません。
無効なリクエストの詳細。
各タイプのエラーの原因となる特定の条件または理由について説明します。
このエラーで返された HTTP ステータス コード。
このエラーで返されたアプリケーション エラー コード。
エラーに関する詳細情報を提供するために使用されるパラメーター。
このエラーで返されたアプリケーション エラー メッセージ。
支払いが必要です。
無効なリクエストの詳細。
各タイプのエラーの原因となる特定の条件または理由について説明します。
このエラーで返された HTTP ステータス コード。
このエラーで返されたアプリケーション エラー コード。
エラーに関する詳細情報を提供するために使用されるパラメーター。
このエラーで返されたアプリケーション エラー メッセージ。
Forbidden.
無効なリクエストの詳細。
各タイプのエラーの原因となる特定の条件または理由について説明します。
このエラーで返された HTTP ステータス コード。
このエラーで返されたアプリケーション エラー コード。
エラーに関する詳細情報を提供するために使用されるパラメーター。
このエラーで返されたアプリケーション エラー メッセージ。
見つかりません。
無効なリクエストの詳細。
各タイプのエラーの原因となる特定の条件または理由について説明します。
このエラーで返された HTTP ステータス コード。
このエラーで返されたアプリケーション エラー コード。
エラーに関する詳細情報を提供するために使用されるパラメーター。
このエラーで返されたアプリケーション エラー メッセージ。
競合。
無効なリクエストの詳細。
各タイプのエラーの原因となる特定の条件または理由について説明します。
このエラーで返された HTTP ステータス コード。
このエラーで返されたアプリケーション エラー コード。
エラーに関する詳細情報を提供するために使用されるパラメーター。
このエラーで返されたアプリケーション エラー メッセージ。
内部サーバーエラー。
無効なリクエストの詳細。
各タイプのエラーの原因となる特定の条件または理由について説明します。
このエラーで返された HTTP ステータス コード。
このエラーで返されたアプリケーション エラー コード。
エラーに関する詳細情報を提供するために使用されるパラメーター。
このエラーで返されたアプリケーション エラー メッセージ。
atlas api upgradeSharedCluster --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.UpgradeSharedClusterApiParams{}
sdkResp, httpResp, err := client.ClustersApi.
UpgradeSharedClusterWithParams(ctx, params).
Execute()
}
curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \
-d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \
-d '{ <Payload> }'
{
"acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
"advancedConfiguration": {
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {
"compute": {
"enabled": false,
"predictiveEnabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {
"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"diskSizeGB": 42.0,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"globalClusterSelfManagedSharding": true,
"labels": [
{
"key": "string",
"value": "string"
}
],
"mongoDBEmployeeAccessGrant": {
"expirationTime": "2025-05-04T09:42:00Z",
"grantType": "CLUSTER_DATABASE_LOGS"
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {
"providerName": "AWS",
"autoScaling": {
"compute": {
"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 42,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "WORKLOAD_TYPE",
"replicationFactor": 3,
"replicationSpec": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"replicationSpecs": [
{
"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"tags": [
{
"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}
{
"acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
"advancedConfiguration": {
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {
"compute": {
"enabled": false,
"predictiveEnabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {
"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {
"awsPrivateLink": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"awsPrivateLinkSrv": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"private": "string",
"privateEndpoint": [
{
"connectionString": "string",
"endpoints": [
{
"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2025-05-04T09:42:00Z",
"diskSizeGB": 42.0,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2025-05-04T09:42:00Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [
{
"key": "string",
"value": "string"
}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {
"expirationTime": "2025-05-04T09:42:00Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"mongoURI": "string",
"mongoURIUpdated": "2025-05-04T09:42:00Z",
"mongoURIWithOptions": "string",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {
"providerName": "AWS",
"autoScaling": {
"compute": {
"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 42,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "WORKLOAD_TYPE",
"replicationFactor": 3,
"replicationSpec": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"replicationSpecs": [
{
"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"srvAddress": "string",
"stateName": "IDLE",
"tags": [
{
"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 402,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Payment Required",
"errorCode": "NO_PAYMENT_INFORMATION_FOUND"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
{
"error": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}