1 つの共有階層クラスターのアップグレード

POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade

指定されたプロジェクトの共有階層クラスターを Flex または専有（M10+）クラスターにアップグレードします。各プロジェクトは最大 25 クラスターに対応します。

このエンドポイントとなる接続されたデバイスは、クラスターの作成APIを使用して作成された Flex クラスターや、Flex クラスターに移行された以前の M2/M5 クラスターを、instanceSizeName から M2 を使用してアップグレードするためにも使用できます。 M5 は 1 月 2026 まで。この機能は、222026 まで使用でき、その後は M0 クラスターでのみ使用できます。代わりに、 Flex Cluster のアップグレードエンドポイントを使用してください。

ロールの要件

プロジェクトクラスターマネージャー

FlexClusterをアップグレードする

path パラメータ

グループ ID string 必須

プロジェクトを識別する一意の 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

クエリパラメータ

envelope ブール値

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータスパラメータを追加します。

デフォルト値はfalseです。
pretty ブール値

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

デフォルト値はfalseです。

Prettyprint

application/ JSON

body 必須

指定されたプロジェクト内の共有階層クラスターのアップグレードの詳細。

acceptDataRisksAndForceReplicaSetReconfig string(date-time)

リージョン停止時によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを提出して、新たなリージョン停止時に耐性のあるトポロジーをリクエスト。複製された書き込み（過半数がコミットされた書き込みであっても）が新しいプライマリノードに複製されていない場合、選挙可能なノードの過半数が停止時に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas の docs に詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定します。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

レプリカセットの再構成では...
高度な構成オブジェクト

高度な構成の詳細のサブセットを構成する設定のグループ。
advancedConfiguration 属性を非表示にする advancedConfiguration 属性の表示オブジェクト
- customOpensslCisphereConfigTls12 array[string]
  
  TLS 1.2 のカスタム OpenSSL 暗号スイートリスト。tlsCipherConfigMode = CUSTOM が必要です。 tlsCipherConfigMode が省略されている場合、空でないリストを指定すると CUSTOM が推測されます。
  
  値は TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 または TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 です。
- customOpensslCisphereConfigTls13 array[string]
  
  TLS 1.3 のカスタム OpenSSL 暗号スイートリスト。tlsCipherConfigMode = CUSTOM が必要です。 tlsCipherConfigMode が省略されている場合、空でないリストを指定すると CUSTOM が推測されます。
  
  4 要素以下値は、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_GCM_SHA256、または TLS_AES_128_CCM_SHA256 です。
- minimumEnabledTlsProtocol string
  
  クラスターが受信接続に受け入れる TLS（Transport Layer Security）の最小バージョン。TLS 1.0 または 1.1 を使用するクラスターでは、TLS プロトコルの最小バージョンとして TLS 1.2 を設定することを検討する必要があります。
  
  値は、TLS1_0、TLS1_1、TLS1_2、または TLS1_3 です。
  
  このオプションは、... に対応します。
- tlsCisphereConfigMode string
  
  TLS 暗号スイートの構成モード。デフォルトモードでは、デフォルトの暗号スイートが使用されます。カスタムモードでは、 TLS 1.2 と TLS 1.3 の両方のカスタム暗号スイートを指定できます。
  
  値は CUSTOM または DEFAULT です。
autoScaling オブジェクト

クラスターを増やすことができるインスタンスサイズの範囲。

クラスターの自動スケーリング
autoScaling 属性を非表示にする autoScaling 属性の表示オブジェクト
- compute オブジェクト
  
  クラスターがクラスター層を増やす方法と、クラスターが増やすダウンできるかどうかを構成する設定のコレクション。低 CPU または NVMEストレージクラスを使用するクラスターでは、クラスター階層のオートスケーリングは使用できません。
  コンピューティング属性を非表示コンピューティング属性の表示オブジェクト
  
  enabled ブール値
  
  インスタンスサイズのリアクティブなオートスケーリングが有効になっているかどうかを示すフラグ。
  
  インスタンスサイズのリアクティブなオートスケーリングを有効にするには、true に設定します。有効にする場合は、providerSettings.autoScaling.compute.maxInstanceSize の値を指定する必要があります。
  
  Set to false to disable instance size reactive auto-scaling.
  
  デフォルト値はfalseです。
  
  scaleDownEnabled ブール値
  
  リアクティブなオートスケーリングによってクラスター階層を増やすダウンできるかどうかを示すフラグ。autoScaling.compute.enabled が true の場合はこれが必要です。このオプションを有効にする場合は、providerSettings.autoScaling.compute.minInstanceSize の値を指定します。
  
  デフォルト値はfalseです。
- DiskGBEnabled ブール値
  
  このクラスターでディスクのオートスケーリングが有効になっているかどうかを示すフラグ。
  
  デフォルト値はfalseです。
backupEnabled ブール値

クラスターがバックアップを実行できるかどうかを示すフラグ。true に設定されていると、クラスターはバックアップを実行できます。NVMe クラスターの場合、この値を true に設定する必要があります。バックアップは、専用クラスターにはクラウドバックアップを使用し、テナントクラスターには共有クラスターバックアップを使用します。false に設定されていると、クラスターは MongoDB Cloud バックアップを使用しません。
BI Connector オブジェクト

このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。

MongoDB Connector for Business...
bioConnector 属性を非表示にする bioConnector 属性の表示オブジェクト
- enabled ブール値
  
  MongoDB Connector for Business Intelligence が指定されたクラスターで有効になっているかどうかを示すフラグ。
- readPreference string
  
  Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to ANALYTICS node, or SECONDARY if there are no ANALYTICS nodes.
  
  値は PRIMARY、SECONDARY、または ANALYTICS です。
  
  Read preferences for BI Connector
clusterType string

クラスターを構成するノードの構成。

値は REPLICASET、SHARDED、または GEOSHARDED です。
configServerManagementMode string

シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバーマネジメントモード。ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスと節約のためにクラスターのコンフィギュレーションサーバータイプを自動的に切り替える場合があります。FIXED_TO_DEDICATED として構成されている場合、クラスターは常に専用のコンフィギュレーションサーバーを使用します。

値は ATLAS_MANAGED または FIXED_TO_DEDICATED です。デフォルト値は ATLAS_MANAGED です。

MongoDBクラスターの構成...
deleteAfterCreationHours integer(int32)

このクラスターが自動的に削除されるクラスター作成後の時間数。

このフィールドは、createDate に対する deleteAfterDate を生成するために使用されます。

クラスターの作成時に null またはゼロに設定されている場合、クラスターは自動的に削除されません。

クラスターの作成時に正の値に設定すると、クラスターは指定された時間数後に自動的に削除されます。

既存の（削除されていない）クラスターでこのフィールドを更新し、null に設定している場合、既存の値はこのと deleteAfterDate で保持されます。

既存の（削除されていない）クラスターでこのフィールドを更新し、かつゼロに設定されている場合、以前の構成に関係なく、deleteAfterDate は null（自動削除を無効）にリセットされます。

既存の（削除されていない）クラスターでこのフィールドを更新し、これが正の値に設定されている場合、createDate + deleteAfterCreationHours はより後である必要があります。そうでない場合、フィールドの更新は無視され、既存の値はこのおよびのために保持されます。 deleteAfterDate。
diskSizeGB number(double)

インスタンスデータボリュームのストレージ容量（ギガバイト単位）。この数を増やすと、容量が追加されます。

この値は、M 0 /M 2 /M 5クラスターでは構成できません。

MongoDB Cloud では、replicationSpecs を設定する場合にこのパラメータが必要です。

最小（ 10 GB）より小さいディスクサイズを指定する場合、このパラメータはデフォルトで最小ディスクサイズ値になります。

ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。

ディスクストレージの最大値は、選択したクラスターの最大 RAM の50倍を超えることはできません。より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。

Minimum value is 10, maximum value is 4096.
diskWarmingMode string

ディスクウォーミングモードの選択。

値は FULLY_WARMED または VISIBLE_EARLIER です。デフォルト値は FULLY_WARMED です。

セカンダリディスクウォーミングを削減 ...
encryptionAtRestProvider string

カスタマーキーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウドサービスプロバイダー。保管時の暗号化のためのカスタマーキーマネジメントを有効にするには、クラスターの replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 設定が M10 以上、かつ "backupEnabled" : false または完全に省略されている必要があります。

値は、NONE、AWS、AZURE、または GCP です。

カスタムを使用した保管時の暗号化...
globalClusterSelfManagedSharding ブール値

新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドをに設定します。

false に設定されている場合、マネジメントモードは Atlas マネージドシャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。

true に設定されている場合、マネジメントモードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。

この設定は、クラスターが配置されると変更できません。

グローバルクラスターの作成
labels array[オブジェクト] 非推奨

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。

クラスターラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソースタグを使用することを強くお勧めします。

Resource Tags
ラベル属性を非表示ラベル属性の表示オブジェクト
このMongoDB Cloud コンポーネントに適用された、人間が判読可能なラベル。
- キー string
  
  このコンポーネントをタグ付けおよび分類するために適用されるキー。
  
  Minimum length is 1, maximum length is 255.
- 価値 string
  
  このコンポーネントをタグ付けおよび分類するために適用されるキーに設定された値。
  
  Minimum length is 1, maximum length is 255.
mongoDBMajorVersion string

クラスターの MongoDB メジャーバージョン。

作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリースサイクルを通じて最新のリリースバージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョンエンドポイントの API エンドポイントを使用してください。

更新時: 一度に1メジャーバージョンをつだけ上げてください。クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャーバージョンにダウングレードできます。

... で利用可能なMongoDB のバージョン
mongoDBVersion string

クラスターが実行する MongoDB のバージョン。

形式は次のパターンと一致する必要があります: ([\d]+\.[\d]+\.[\d]+)。
name string 必須

クラスターを識別する人間が判読できるラベル。

形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$。
numShards integer(int32)

シャーディングされたクラスターに配置できるシャードの数は最大 50 個です。リソースは、レプリカセットを示す場合は 1 を返し、シャーディングされたクラスターを示す場合は 2 以上の値を返します。戻り値は、クラスター内のシャードの数と等しくなります。

最小値は 1、最大値は 50 です。デフォルト値は 1 です。

シャーディング
paused ブール値

クラスターが一時停止しているかどうかを示すフラグ。
pitEnabled ブール値

クラスターが継続的なクラウドバックアップを使用するかどうかを示すフラグ。

継続的なクラウドバックアップ
providerBackupEnabled ブール値

M10 以上のクラスターがクラウドバックアップを実行できるかどうかを示すフラグ。true に設定されている場合、クラスターはバックアップを実行できます。これと backupEnabled が false に設定されている場合、クラスターはMongoDB クラウドバックアップを使用しません。
providerSettings オブジェクト
次の 1 つ：
AWS object AZURE object GCP object TENANT object FLEX object
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
属性を非表示属性を表示

providerName string 必須弁別子

値は AWS です。

autoScaling オブジェクト

クラスターを増やすことができるインスタンスサイズの範囲。

autoScaling 属性を非表示 autoScaling 属性の表示オブジェクト

compute オブジェクト

Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.

Hide compute attributes Show compute attributes オブジェクト

maxInstanceSize string

クラスターがオート増やすできる最大インスタンスサイズ

値は 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、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、 R200_GEN_2、R300_GEN_2、R400_GEN_2、R700_GEN_2、M40_NVME_GEN_2、M50_NVME_GEN_2、M60_NVME_GEN_2、M80_NVME_GEN_2、M200_NVME_GEN_2、または M400_NVME_GEN_2

minInstanceSize string

クラスターがオート増やすできる最小インスタンスサイズ。

値は 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、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、 R200_GEN_2、R300_GEN_2、R400_GEN_2、R700_GEN_2、M40_NVME_GEN_2、M50_NVME_GEN_2、M60_NVME_GEN_2、M80_NVME_GEN_2、M200_NVME_GEN_2、または M400_NVME_GEN_2

DiskIOPS integer(int32)

データベースホストが実行できる 1 秒あたりの最大ディスク入力/出力操作数（IOPS）。

encryptEBSVolume ブール値非推奨

EBS（ Amazon Elastic Block Store）暗号化機能が、ボリューム内の保管中のデータと、ボリュームとクラスターの間を移動するデータの両方について、ホストのルートボリュームを暗号化するかどうかを示すフラグ。クラスターでは、この設定は常に有効になっています。

デフォルト値はtrueです。

instanceSizeName string

クラスター階層（デフォルトのストレージとメモリキャパシティー）で、クラスター内のすべてのデータ保持ホストに適用されます。

値は 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、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、 R200_GEN_2、R300_GEN_2、R400_GEN_2、R700_GEN_2、M40_NVME_GEN_2、M50_NVME_GEN_2、M60_NVME_GEN_2、M80_NVME_GEN_2、M200_NVME_GEN_2、または M400_NVME_GEN_2

regionName string

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_EAST_2、AP_NORTHEAST_1、AP_NORTHEAST_2、AP_NORTHEAST_3、AP_SOUTHEAST_1、AP_SOUTHEAST_2、AP_SOUTHEAST_3、AP_SOUTHEAST_4、AP_SOUTHEAST_5、AP_SOUTHEAST_6、AP_SOUTHEAST_7、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、 MX_CENTRAL_1、または GLOBAL。

Amazon Web Services

volumeType string

Amazon Web Services（AWS）ストレージのディスク入力/出力 1 秒あたりの操作（IOPS）設定。AWS のみに設定します。ディスク入力/出力 1 秒あたりの操作（IOPS）が、選択したボリュームサイズ（STANDARD）のデフォルトの 1 秒あたりの入力/出力操作（IOPS）レートを超えてはならないか、または選択したボリュームサイズ（PROVISIONEDまたはHIGH_PERFORMANCE）の 1 秒あたりの入力/出力操作（IOPS）の許容範囲内に収まる必要があるかを指定します。NVMe クラスターには、PROVISIONEDまたはHIGH_PERFORMANCEが必要です。

値は STANDARD、PROVISIONED、または HIGH_PERFORMANCE です。
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
属性を非表示属性を表示

providerName string 必須弁別子

値は AZURE です。

autoScaling オブジェクト

クラスターを増やすことができるインスタンスサイズの範囲。

Hide autoScaling attribute Show autoScaling attribute オブジェクト

compute オブジェクト

Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.

Hide compute attributes Show compute attributes オブジェクト

maxInstanceSize string

Maximum instance size to which your cluster can automatically scale.

Values are 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, or M600_NVME.

minInstanceSize string

Minimum instance size to which your cluster can automatically scale.

Values are 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, or M600_NVME.

diskTypeName string

Azureインスタンスのホストのルートボリュームに対応するディスクの種類。省略した場合、選択した providerSettings.instanceSizeName のデフォルトのディスクタイプが適用されます。

値は、P2、P3、P4、P6、P10、P15、P20、P30、P40、または P50 です。

Disk type

instanceSizeName string

クラスター階層（デフォルトのストレージとメモリキャパシティー）で、クラスター内のすべてのデータ保持ホストに適用されます。

Values are 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, or M600_NVME.

regionName string

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、US_GOV_VIRGINIA、US_GOV_ARIZONA、または US_GOV_TEXAS 。

Azure
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
属性を非表示属性を表示

providerName string 必須弁別子

値は GCP です。

autoScaling オブジェクト

クラスターを増やすことができるインスタンスサイズの範囲。

Hide autoScaling attribute Show autoScaling attribute オブジェクト

compute オブジェクト

Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.

Hide compute attributes Show compute attributes オブジェクト

maxInstanceSize string

Maximum instance size to which your cluster can automatically scale.

値は M10、M20、M30、M40、M50、M60、M80、M140、M200、M250、M300、M400、 R40、R50、R60、R80、R200、R300、R400、R600、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、R200_GEN_2、R300_GEN_2、または R400_GEN_2

minInstanceSize string

Minimum instance size to which your cluster can automatically scale.

値は M10、M20、M30、M40、M50、M60、M80、M140、M200、M250、M300、M400、 R40、R50、R60、R80、R200、R300、R400、R600、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、R200_GEN_2、R300_GEN_2、または R400_GEN_2

instanceSizeName string

クラスター階層（デフォルトのストレージとメモリキャパシティー）で、クラスター内のすべてのデータ保持ホストに適用されます。

値は M10、M20、M30、M40、M50、M60、M80、M140、M200、M250、M300、M400、 R40、R50、R60、R80、R200、R300、R400、R600、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、R200_GEN_2、R300_GEN_2、または R400_GEN_2

regionName string

Google compute リージョン。

Values are 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, or ASIA_SOUTHEAST_2.

GCP
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
属性を非表示属性を表示

providerName string 必須弁別子

値は TENANT です。

autoScaling オブジェクト

クラスターを増やすことができるインスタンスサイズの範囲。

Hide autoScaling attribute Show autoScaling attribute オブジェクト

compute オブジェクト

クラスターがクラスター層を増やす方法と、クラスターが増やすダウンできるかどうかを構成する設定のコレクション。

Hide compute attributes Show compute attributes オブジェクト

maxInstanceSize string

Maximum instance size to which your cluster can automatically scale.

値は M0、M2、または M5 です。

minInstanceSize string

Minimum instance size to which your cluster can automatically scale.

値は M0、M2、または M5 です。

backupProviderName string

MongoDB Cloud がマルチテナントホストをプロビジョニングしたクラウドサービスプロバイダー。リソースは、providerSettings.providerName が TENANT で、かつ providerSetting.instanceSizeName が M0、M2、または M5 の場合にこのパラメータを返します。

M2 または M5 の instanceSize を使用すると、代わりに Flex クラスターが作成されることに注意してください。M2または M5 の instanceSize のサポートは 1 月 2026 で終了します。このような構成には、 Flex Cluster APIを使用することをお勧めします。

値は AWS、GCP、または AZURE です。

Flex Cluster API の作成

instanceSizeName string

クラスター階層（デフォルトのストレージとメモリキャパシティー）で、クラスター内のすべてのデータ保持ホストに適用されます。providerSettings.providerName を TENANT に設定し、providerSettings.backingProviderName にクラウドサービスプロバイダーを指定する必要があります。

値は M0、M2、または M5 です。

regionName string

MongoDBクラスターの地理的ロケーションを識別する、人間が判読できるラベル。選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。リージョン名の完全なリストについては、AWS、GCP、Azureを参照してください。マルチリージョンクラスターについては、 replicationSpec.{region} を参照してください。
プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
属性を非表示属性を表示

providerName string 必須弁別子

値は FLEX です。

backingProviderName string

MongoDB Cloud がマルチテナントホストをプロビジョニングしたクラウドサービスプロバイダー。providerSettings.providerName が FLEX で、かつ providerSetting.instanceSizeName が FLEX の場合、リソースはこのパラメータを返します。

値は AWS、GCP、または AZURE です。

instanceSizeName string

クラスター階層（デフォルトのストレージとメモリキャパシティー）で、クラスター内のすべてのデータ保持ホストに適用されます。providerSettings.providerName を FLEX に設定し、providerSettings.backingProviderName にクラウドサービスプロバイダーを指定する必要があります。

値は FLEX です。

regionName string

Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.
replicaSetScalingStratey string

クラスターのレプリカセットスケーリングモードを構成するには、このフィールドをに設定します。

デフォルトでは、Atlas は WORKLOAD_TYPE の下でスケーリングされます。このモードでは、Atlas は分析ノードを運用ノードと並行して増やすできます。

SEQUENTIAL として構成すると、Atlas はすべてのノードを順次スケーリングします。このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。

NODE_TYPE に設定すると、Atlas は選挙可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。このモードは、頻繁にクラスター階層を拡大することを必要とする大規模で動的ワークロードを対象としています。これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響可能性があります。

値は SEQUENTIAL、WORKLOAD_TYPE、または NODE_TYPE です。デフォルト値は WORKLOAD_TYPE です。

レプリカセットのスケーリングを変更...
replicationFactor integer(int32) 非推奨

レプリカセットに属するノードの数。各ノードはデータベースのコピーを保持し、高可用性とデータの冗長性を提供します。代わりに replicationSpecs を使用してください。

値は 3、5、または 7 です。デフォルト値は 3 です。
replicationSpec オブジェクト

MongoDB Cloud がクラスターノードをプロビジョニングする物理的なロケーション。
replicationSpec 属性を非表示 replicationSpec 属性の表示オブジェクト
- * オブジェクト additionalProperties
  
  MongoDB Cloud がクラスターノードをプロビジョニングする物理的なロケーション。
  * 属性を非表示 * 属性を表示オブジェクト
  
  analyzeNodes integer(int32)
  
  リージョン内の分析ノードの数。分析ノードは、MongoDB Cloud 上のMongoDB Connector for Business Intelligence からのクエリのレポート作成などの分析データを取り扱います。分析ノードは読み取り専用であり、プライマリになることはできません。代わりに replicationSpecs[n].{region}.analyticsNodes を使用してください。
  
  electionableNodes integer(int32)
  
  指定されたリージョンに配置する選択可能なノードの数。選択可能なノードはプライマリになることができ、ローカル読み取りが容易になります。代わりに replicationSpecs[n].{region}.electableNodes を使用してください。
  
  値は、0、3、5、または 7 です。
  
  優先順位 integer(int32)
  
  Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to 7. The primary node runs in the Preferred Region. To identify a read-only region, set this parameter to 0.
  
  Minimum value is 0, maximum value is 7.
  
  readOnlyNodes integer(int32)
  
  リージョン内の読み取り専用ノードの数。読み取り専用ノードはプライマリノードになることはできませんが、ローカル読み取りを容易にできます。代わりに replicationSpecs[n].{region}.readOnlyNodes を使用してください。
replicationSpecs array[オブジェクト]
クラスターリージョンを構成する設定のリスト。
- グローバルクラスターの場合、配列内の各オブジェクトは、MongoDB Cloud がクラスターノードを配置する 1 つのゾーンを表します。
- 非グローバルのシャーディングされたクラスターとレプリカセットの場合、1 つのオブジェクトは MongoDB Cloud がクラスターノードを配置する場所を表します。
replicationSpecs 属性を非表示にする replicationSpecs 属性の表示オブジェクト
- id string
  グローバルクラスター内のゾーンのレプリケーションオブジェクトを識別する一意な 24 桁の 16 進数文字列。
  
  リクエストに既存のゾーンを含める場合は、このパラメーターを指定する必要があります。
  
  既存のグローバルクラスターに新しいゾーンを追加する場合は、このパラメーターを指定できます。リクエストは、リクエストから除外したグローバルクラスター内の既存のゾーンを削除します。
  形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
- numShards integer(int32)
  
  指定された各ゾーンに配置するシャードの数を指定する正の整数。この値を 1 に設定し、clusterType が SHARDED の場合、 MongoDB Cloud は単一シャードのシャーディングされたクラスターを配置します。実稼働環境では、単一のシャードを含むシャーディングされたクラスターを作成しないでください。単一シャードのシャードクラスターでは、マルチシャード構成と同じ利点は得られません。
  
  レプリカセットをシャーディングされたクラスターにアップグレードする場合、同じ更新リクエストでシャードの数を増やすことはできません。クラスターがシャーディングへのアップグレードを完了し、すべてのアプリケーションクライアントをMongoDBルーターに再接続してから、追加のシャードを追加する必要があります。そうしないと、 MongoDB Cloud によってシャード間でのデータ分散が開始された後、データの整合性が失われる可能性があります。
  
  デフォルト値は1です。
- regionsConfig オブジェクト
  
  MongoDB Cloud がクラスターノードをプロビジョニングする物理的なロケーション。
  regionConfig 属性を非表示 regionConfig 属性の表示オブジェクト
  
  * オブジェクト additionalProperties
  
  MongoDB Cloud がクラスターノードをプロビジョニングする物理的なロケーション。
  
  Hide * attributes Show * attributes オブジェクト
  
  analyticsNodes integer(int32)
  
  リージョン内の分析ノードの数。分析ノードは、MongoDB Cloud 上のMongoDB Connector for Business Intelligence からのクエリのレポート作成などの分析データを取り扱います。分析ノードは読み取り専用であり、プライマリになることはできません。代わりに replicationSpecs[n].{region}.analyticsNodes を使用してください。
  
  electableNodes integer(int32)
  
  指定されたリージョンに配置する選択可能なノードの数。選択可能なノードはプライマリになることができ、ローカル読み取りが容易になります。代わりに replicationSpecs[n].{region}.electableNodes を使用してください。
  
  値は、0、3、5、または 7 です。
  
  優先順位 integer(int32)
  
  Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to 7. The primary node runs in the Preferred Region. To identify a read-only region, set this parameter to 0.
  
  Minimum value is 0, maximum value is 7.
  
  readOnlyNodes integer(int32)
  
  リージョン内の読み取り専用ノードの数。読み取り専用ノードはプライマリノードになることはできませんが、ローカル読み取りを容易にできます。代わりに replicationSpecs[n].{region}.readOnlyNodes を使用してください。
- zoneName string
  
  グローバルクラスター内のゾーンを識別する、人間が判読できるラベル。この値は、clusterType が GEOSHARDED の場合にのみ指定します。
rootCertType string

MongoDB Atlasクラスターが使用するルート認証局。MongoDB Cloud は Internet Research Group をサポートしています。

値は ISRGROOTX1 です。デフォルト値は ISRGROOTX1 です。
tags array[オブジェクト]

クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。

Resource Tags
Hide tags attributes タグ属性の表示オブジェクト
Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, environment : production.
- キー string 必須
  
  タグのセットを定義する定数。たとえば、 environment : productionタグ内のenvironment 。
  
  Minimum length is 1, maximum length is 255.
- 価値 string 必須
  
  タグのセットに属する変数。たとえば、 environment : productionタグ内のproduction 。
  
  Minimum length is 1, maximum length is 255.
terminationProtectionEnabled ブール値

クラスターで終了保護が有効になっているかどうかを示すフラグ。true に設定されていると、MongoDB Cloud はクラスターを削除しません。false に設定されていると、MongoDB Cloud はクラスターを削除します。

デフォルト値はfalseです。
versionReleaseSystem string

クラスターがMongoDB のバージョンを管理する方法。値が CONTINUOUS の場合、mongoDBMajorVersion を指定しないでください。

値は LTS または CONTINUOUS です。デフォルト値は LTS です。

応答

200 application/ JSON

OK
応答属性の非表示応答属性の表示オブジェクト
- acceptDataRisksAndForceReplicaSetReconfig string(date-time)
  
  リージョン停止時によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを提出して、新たなリージョン停止時に耐性のあるトポロジーをリクエスト。複製された書き込み（過半数がコミットされた書き込みであっても）が新しいプライマリノードに複製されていない場合、選挙可能なノードの過半数が停止時に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas の docs に詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定します。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
  
  レプリカセットの再構成では...
- 高度な構成オブジェクト
  
  高度な構成の詳細のサブセットを構成する設定のグループ。
  
  Hide advancedConfiguration attributes Show advancedConfiguration attributes オブジェクト
  
  customOpensslCisphereConfigTls12 array[string]
  
  TLS 1.2 のカスタム OpenSSL 暗号スイートリスト。tlsCipherConfigMode = CUSTOM が必要です。 tlsCipherConfigMode が省略されている場合、空でないリストを指定すると CUSTOM が推測されます。
  
  値は TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 または TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 です。
  
  customOpensslCisphereConfigTls13 array[string]
  
  TLS 1.3 のカスタム OpenSSL 暗号スイートリスト。tlsCipherConfigMode = CUSTOM が必要です。 tlsCipherConfigMode が省略されている場合、空でないリストを指定すると CUSTOM が推測されます。
  
  4 要素以下値は、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_GCM_SHA256、または TLS_AES_128_CCM_SHA256 です。
  
  minimumEnabledTlsProtocol string
  
  クラスターが受信接続に受け入れる TLS（Transport Layer Security）の最小バージョン。TLS 1.0 または 1.1 を使用するクラスターでは、TLS プロトコルの最小バージョンとして TLS 1.2 を設定することを検討する必要があります。
  
  値は、TLS1_0、TLS1_1、TLS1_2、または TLS1_3 です。
  
  このオプションは、... に対応します。
  
  tlsCisphereConfigMode string
  
  TLS 暗号スイートの構成モード。デフォルトモードでは、デフォルトの暗号スイートが使用されます。カスタムモードでは、 TLS 1.2 と TLS 1.3 の両方のカスタム暗号スイートを指定できます。
  
  値は CUSTOM または DEFAULT です。
- autoScaling オブジェクト
  
  クラスターを増やすことができるインスタンスサイズの範囲。
  
  クラスターの自動スケーリング
  
  Hide autoScaling attributes Show autoScaling attributes オブジェクト
  
  compute オブジェクト
  
  Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
  
  Hide compute attributes Show compute attributes オブジェクト
  
  enabled ブール値
  
  Flag that indicates whether instance size reactive auto-scaling is enabled.
  
  インスタンスサイズのリアクティブなオートスケーリングを有効にするには、true に設定します。有効にする場合は、providerSettings.autoScaling.compute.maxInstanceSize の値を指定する必要があります。
  
  Set to false to disable instance size reactive auto-scaling.
  
  デフォルト値はfalseです。
  
  scaleDownEnabled ブール値
  
  リアクティブなオートスケーリングによってクラスター階層を増やすダウンできるかどうかを示すフラグ。autoScaling.compute.enabled が true の場合はこれが必要です。このオプションを有効にする場合は、providerSettings.autoScaling.compute.minInstanceSize の値を指定します。
  
  デフォルト値はfalseです。
  
  diskGBEnabled ブール値
  
  Flag that indicates whether someone enabled disk auto-scaling for this cluster.
  
  デフォルト値はfalseです。
- backupEnabled ブール値
  
  クラスターがバックアップを実行できるかどうかを示すフラグ。true に設定されていると、クラスターはバックアップを実行できます。NVMe クラスターの場合、この値を true に設定する必要があります。バックアップは、専用クラスターにはクラウドバックアップを使用し、テナントクラスターには共有クラスターバックアップを使用します。false に設定されていると、クラスターは MongoDB Cloud バックアップを使用しません。
- BI Connector オブジェクト
  
  このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。
  
  MongoDB Connector for Business...
  
  Hide biConnector attributes Show biConnector attributes オブジェクト
  
  enabled ブール値
  
  Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster.
  
  readPreference string
  
  Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to ANALYTICS node, or SECONDARY if there are no ANALYTICS nodes.
  
  値は PRIMARY、SECONDARY、または ANALYTICS です。
  
  Read preferences for BI Connector
- clusterType string
  
  クラスターを構成するノードの構成。
  
  値は REPLICASET、SHARDED、または GEOSHARDED です。
- configServerManagementMode string
  
  シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバーマネジメントモード。ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスと節約のためにクラスターのコンフィギュレーションサーバータイプを自動的に切り替える場合があります。FIXED_TO_DEDICATED として構成されている場合、クラスターは常に専用のコンフィギュレーションサーバーを使用します。
  
  値は ATLAS_MANAGED または FIXED_TO_DEDICATED です。デフォルト値は ATLAS_MANAGED です。
  
  MongoDBクラスターの構成...
- configServerType string
  
  シャーディングされたクラスターのコンフィギュレーションサーバーのタイプを説明します。
  
  値は DEDICATED または EMBEDDED です。
  
  MongoDBクラスターの構成...
- 接続文字列オブジェクト
  
  MongoDB データベースを指すユニフォームリソースロケータのコレクション。
  
  接続文字列 URI 形式。
  
  connectionStrings 属性を非表示にする connectionStrings 属性の表示オブジェクト
  
  awsPrivateLink オブジェクト
  
  Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related mongodb:// connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.
  
  ネットワークピアリング接続
  
  awsPrivateLink 属性を非表示にする awsPrivateLink 属性を表示オブジェクト
  
  * string additionalProperties
  
  Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related mongodb:// connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.
  
  ネットワークピアリング接続
  
  awsPrivateLinkSrv オブジェクト
  
  Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related mongodb:// connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, awsPrivateLinkSrv contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, awsPrivateLinkSrv contains the non-optimized connection string even if an optimized connection string is also present.
  
  ネットワークピアリング接続
  
  awsPrivateLinkSrv 属性を非表示にする awsPrivateLinkSrv 属性を表示オブジェクト
  
  * string additionalProperties
  
  Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related mongodb:// connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, awsPrivateLinkSrv contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, awsPrivateLinkSrv contains the non-optimized connection string even if an optimized connection string is also present.
  
  ネットワークピアリング接続
  
  private string
  
  このクラスターに接続するために構成した各インターフェースの仮想プライベートクラウド（VPC）エンドポイントのネットワークピアリング接続文字列。この接続文字列はmongodb+srv://プロトコルを使用します。リソースは、このクラスターへのネットワークピアリング接続がユーザーが作成すると、このパラメーターを返します。このプロトコルは、アプリケーションにDNS（Domain Name System）でホストシードリストを検索するように指示します。このリストは、クラスター内のノードと同期します。接続文字列がこの URI（Uniform Resource Identifier）形式を使用している場合、ノードが変更された場合にシードリストを追加したり、URI を変更したりする必要はありません。ドライバーが URI 形式をサポートしている場合は、この URI形式を使用します。問題が発生しない場合は、connectionStrings.private を使用します。Amazon Web Services （AWS）クラスターの場合、このリソースはカスタム DNS を有効にしている場合にのみこのパラメーターを返します。
  
  ネットワークピアリング接続
  
  privateEndpoint array[オブジェクト]
  
  プライベートエンドポイント経由でこのクラスターに接続するために使用できるプライベートエンドポイント対応接続文字列のリスト。このパラメーターは、このクラスターのノードを配置したすべてのリージョンにプライベートエンドポイントを配置した場合にのみを返します。
  
  privateEndpoint 属性を非表示 privateEndpoint 属性の表示オブジェクト
  
  プライベートエンドポイントを認識する接続文字列。プライベートエンドポイントを介してこのクラスターに接続するために使用できます。
  
  専用のプライベートエンドポイント...
  
  ConnectionString string
  
  Private endpoint-aware connection string that uses the mongodb:// protocol to connect to MongoDB Cloud through a private endpoint.
  
  エンドポイント array[オブジェクト]
  
  connectionStrings.privateEndpoint[n].connectionString または connectionStrings.privateEndpoint[n].srvConnectionString を使用するときにMongoDB Cloud に接続するプライベートエンドポイントを含むリスト。
  
  エンドポイント属性の非表示エンドポイント属性の表示オブジェクト
  
  このクラスターに配置されたプライベートエンドポイントの詳細。
  
  endpointId string
  
  クラウドプロバイダーがプライベートエンドポイントを識別するために使用する一意の string。
  
  providerName string
  
  MongoDB Cloud がプライベートエンドポイントを配置するクラウドプロバイダー。
  
  値は AWS、AZURE、または GCP です。
  
  リージョン string
  
  プライベートエンドポイントが配置されるリージョン。
  
  srvConnectionString string
  
  プライベートエンドポイントを認識する接続文字列。mongodb+srv://プロトコルを使用し、プライベートエンドポイントを介してMongoDB クラウドに接続します。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 を使用します。
  
  srvShardOptimizedConnectionString string
  
  シャーディングされたクラスター用に最適化されたプライベートエンドポイント対応の接続文字列。 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 のドキュメントを参照してください。
  
  タイプ string
  
  MongoDB process type to which your application connects. Use MONGOD for replica sets and MONGOS for sharded clusters.
  
  値は MONGOD または MONGOS です。
  
  privateSrv string
  
  Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the mongodb+srv:// protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this parameter returns only if you enable custom DNS.
  
  ネットワークピアリング接続
  
  標準 string
  
  Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.
  
  接続文字列 URI 形式
  
  standardSrv string
  
  Public connection string that you can use to connect to this cluster. This connection string uses the mongodb+srv:// protocol.
  
  接続文字列 URI 形式
- createDate string(date-time)
  
  MongoDB Cloud がこのサーバーレスインスタンスを作成した日時。MongoDB Cloud は、このタイムスタンプを UTC の ISO 8601形式で表します。
- deleteAfterCreationHours integer(int32)
  
  このクラスターが自動的に削除されるクラスター作成後の時間数。
  
  このフィールドは、createDate に対する deleteAfterDate を生成するために使用されます。
  
  クラスターの作成時に null またはゼロに設定されている場合、クラスターは自動的に削除されません。
  
  クラスターの作成時に正の値に設定すると、クラスターは指定された時間数後に自動的に削除されます。
  
  既存の（削除されていない）クラスターでこのフィールドを更新し、null に設定している場合、既存の値はこのと deleteAfterDate で保持されます。
  
  既存の（削除されていない）クラスターでこのフィールドを更新し、かつゼロに設定されている場合、以前の構成に関係なく、deleteAfterDate は null（自動削除を無効）にリセットされます。
  
  既存の（削除されていない）クラスターでこのフィールドを更新し、これが正の値に設定されている場合、createDate + deleteAfterCreationHours はより後である必要があります。そうでない場合、フィールドの更新は無視され、既存の値はこのおよびのために保持されます。 deleteAfterDate。
- deleteAfterDate string(date-time)
  
  このクラスターが自動的に削除される日付。
  
  このパラメータは、その値を ISO 8601 タイムスタンプ形式で UTC で表し、createDate + deleteAfterCreationHours に基づいて導出されます。
- diskSizeGB number(double)
  
  インスタンスデータボリュームのストレージ容量（ギガバイト単位）。この数を増やすと、容量が追加されます。
  
  この値は、M 0 /M 2 /M 5クラスターでは構成できません。
  
  MongoDB Cloud では、replicationSpecs を設定する場合にこのパラメータが必要です。
  
  最小（ 10 GB）より小さいディスクサイズを指定する場合、このパラメータはデフォルトで最小ディスクサイズ値になります。
  
  ストレージ料金の計算は、デフォルト値を選択するかカスタム値を選択するかによって異なります。
  
  ディスクストレージの最大値は、選択したクラスターの最大 RAM の50倍を超えることはできません。より多くのストレージ容量が必要な場合は、クラスターを上位階層にアップグレードすることを検討してください。
  
  Minimum value is 10, maximum value is 4096.
- diskWarmingMode string
  
  ディスクウォーミングモードの選択。
  
  値は FULLY_WARMED または VISIBLE_EARLIER です。デフォルト値は FULLY_WARMED です。
  
  セカンダリディスクウォーミングを削減 ...
- encryptionAtRestProvider string
  
  カスタマーキーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウドサービスプロバイダー。保管時の暗号化のためのカスタマーキーマネジメントを有効にするには、クラスターの replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 設定が M10 以上、かつ "backupEnabled" : false または完全に省略されている必要があります。
  
  値は、NONE、AWS、AZURE、または GCP です。
  
  カスタムを使用した保管時の暗号化...
- 機能の互換性バージョン string
  
  クラスターの機能の互換性バージョン。
- featureCompatibilityVersionExpirationDate string(date-time)
  
  機能の互換性バージョンの有効期限日。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
- globalClusterSelfManagedSharding ブール値
  
  新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドをに設定します。
  
  false に設定されている場合、マネジメントモードは Atlas マネージドシャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。
  
  true に設定されている場合、マネジメントモードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。
  
  この設定は、クラスターが配置されると変更できません。
  
  グローバルクラスターの作成
- グループ ID string
  
  プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。
  
  形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
- id string
  
  クラスターを識別するユニークな 24 桁の 16 進数の文字列。
  
  形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
- labels array[オブジェクト] 非推奨
  
  クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。
  
  クラスターラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソースタグを使用することを強くお勧めします。
  
  Resource Tags
  
  Hide labels attributes Show labels attributes オブジェクト
  
  Human-readable labels applied to this MongoDB Cloud component.
  
  キー string
  
  Key applied to tag and categorize this component.
  
  Minimum length is 1, maximum length is 255.
  
  価値 string
  
  Value set to the Key applied to tag and categorize this component.
  
  Minimum length is 1, maximum length is 255.
- Links array[オブジェクト]
  
  APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
  
  Web リンク仕様（RFC...
  
  リンク属性を非表示にするリンク属性を表示するオブジェクト
  
  href string
  
  この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。
  
  リリース string
  
  このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。
- mongoDBEmployeeAccessGrant オブジェクト
  
  MongoDB 従業員に付与されるクラスターのアクセスレベルと有効期限。
  
  mongoDBEmployeeAccessGrant 属性を非表示 mongoDBEmployeeAccessGrant 属性の表示オブジェクト
  
  expirationTime string(date-time) 必須
  
  従業員アクセス権の有効期限。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
  
  granType string 必須
  
  MongoDB 従業員に付与するアクセス権のレベル。
  
  値は CLUSTER_DATABASE_LOGS、CLUSTER_INFRASTRUCTURE、または CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA です。
  
  Links array[オブジェクト]
  
  APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
  
  Web リンク仕様（RFC...
  
  リンク属性を非表示にするリンク属性を表示するオブジェクト
  
  href string
  
  この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。
  
  リリース string
  
  このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。
- mongoDBMajorVersion string
  
  クラスターの MongoDB メジャーバージョン。
  
  作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリースサイクルを通じて最新のリリースバージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョンエンドポイントの API エンドポイントを使用してください。
  
  更新時: 一度に1メジャーバージョンをつだけ上げてください。クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャーバージョンにダウングレードできます。
  
  ... で利用可能なMongoDB のバージョン
- mongoDBVersion string
  
  クラスターが実行する MongoDB のバージョン。
  
  形式は次のパターンと一致する必要があります: ([\d]+\.[\d]+\.[\d]+)。
- mongoURI string
  
  クラスターに接続するために使用できる基本接続文字列。 MongoDB Cloud では、クラスターのビルド中ではなく、クラスターの起動後にのみ string が表示されます。
  
  接続文字列 URI 形式。
- mongoURIUpdated string(date-time)
  
  接続文字列が誰かが最後に更新された日時。 MongoDB Cloud は、このタイムスタンプを UTC の ISO 8601形式で表します。
- mongoURIWithOptions string
  
  クラスターに接続するために使用できる接続文字列には、クラスターに適した値を持つ replicaSet、ssl、authSource クエリパラメータが含まれます。 MongoDBデータベースユーザーを追加する必要がある場合があります。レスポンスは、クラスターの構築中ではなく、クラスターがリクエストを受信できると返します。
  
  接続文字列 URI 形式。
- name string
  
  クラスターを識別する人間が判読できるラベル。
  
  形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$。
- numShards integer(int32)
  
  シャーディングされたクラスターに配置できるシャードの数は最大 50 個です。リソースは、レプリカセットを示す場合は 1 を返し、シャーディングされたクラスターを示す場合は 2 以上の値を返します。戻り値は、クラスター内のシャードの数と等しくなります。
  
  最小値は 1、最大値は 50 です。デフォルト値は 1 です。
  
  シャーディング
- paused ブール値
  
  クラスターが一時停止しているかどうかを示すフラグ。
- pitEnabled ブール値
  
  クラスターが継続的なクラウドバックアップを使用するかどうかを示すフラグ。
  
  継続的なクラウドバックアップ
- providerBackupEnabled ブール値
  
  M10 以上のクラスターがクラウドバックアップを実行できるかどうかを示すフラグ。true に設定されている場合、クラスターはバックアップを実行できます。これと backupEnabled が false に設定されている場合、クラスターはMongoDB クラウドバックアップを使用しません。
- providerSettings オブジェクト
  
  次の 1 つ：
  AWS object AZURE object GCP object TENANT object FLEX object
  
  プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
  
  属性を非表示属性を表示
  
  providerName string 必須弁別子
  
  値は AWS です。
  
  autoScaling オブジェクト
  
  クラスターを増やすことができるインスタンスサイズの範囲。
  
  Hide autoScaling attribute Show autoScaling attribute オブジェクト
  
  compute オブジェクト
  
  Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
  
  Hide compute attributes Show compute attributes オブジェクト
  
  maxInstanceSize string
  
  Maximum instance size to which your cluster can automatically scale.
  
  値は 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、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、 R200_GEN_2、R300_GEN_2、R400_GEN_2、R700_GEN_2、M40_NVME_GEN_2、M50_NVME_GEN_2、M60_NVME_GEN_2、M80_NVME_GEN_2、M200_NVME_GEN_2、または M400_NVME_GEN_2
  
  minInstanceSize string
  
  Minimum instance size to which your cluster can automatically scale.
  
  値は 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、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、 R200_GEN_2、R300_GEN_2、R400_GEN_2、R700_GEN_2、M40_NVME_GEN_2、M50_NVME_GEN_2、M60_NVME_GEN_2、M80_NVME_GEN_2、M200_NVME_GEN_2、または M400_NVME_GEN_2
  
  DiskIOPS integer(int32)
  
  データベースホストが実行できる 1 秒あたりの最大ディスク入力/出力操作数（IOPS）。
  
  encryptEBSVolume ブール値非推奨
  
  EBS（ Amazon Elastic Block Store）暗号化機能が、ボリューム内の保管中のデータと、ボリュームとクラスターの間を移動するデータの両方について、ホストのルートボリュームを暗号化するかどうかを示すフラグ。クラスターでは、この設定は常に有効になっています。
  
  デフォルト値はtrueです。
  
  instanceSizeName string
  
  クラスター階層（デフォルトのストレージとメモリキャパシティー）で、クラスター内のすべてのデータ保持ホストに適用されます。
  
  値は 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、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、 R200_GEN_2、R300_GEN_2、R400_GEN_2、R700_GEN_2、M40_NVME_GEN_2、M50_NVME_GEN_2、M60_NVME_GEN_2、M80_NVME_GEN_2、M200_NVME_GEN_2、または M400_NVME_GEN_2
  
  regionName string
  
  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_EAST_2、AP_NORTHEAST_1、AP_NORTHEAST_2、AP_NORTHEAST_3、AP_SOUTHEAST_1、AP_SOUTHEAST_2、AP_SOUTHEAST_3、AP_SOUTHEAST_4、AP_SOUTHEAST_5、AP_SOUTHEAST_6、AP_SOUTHEAST_7、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、 MX_CENTRAL_1、または GLOBAL。
  
  Amazon Web Services
  
  volumeType string
  
  Amazon Web Services（AWS）ストレージのディスク入力/出力 1 秒あたりの操作（IOPS）設定。AWS のみに設定します。ディスク入力/出力 1 秒あたりの操作（IOPS）が、選択したボリュームサイズ（STANDARD）のデフォルトの 1 秒あたりの入力/出力操作（IOPS）レートを超えてはならないか、または選択したボリュームサイズ（PROVISIONEDまたはHIGH_PERFORMANCE）の 1 秒あたりの入力/出力操作（IOPS）の許容範囲内に収まる必要があるかを指定します。NVMe クラスターには、PROVISIONEDまたはHIGH_PERFORMANCEが必要です。
  
  値は STANDARD、PROVISIONED、または HIGH_PERFORMANCE です。
  
  プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
  
  属性を非表示属性を表示
  
  providerName string 必須弁別子
  
  値は AZURE です。
  
  autoScaling オブジェクト
  
  クラスターを増やすことができるインスタンスサイズの範囲。
  
  Hide autoScaling attribute Show autoScaling attribute オブジェクト
  
  compute オブジェクト
  
  Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
  
  Hide compute attributes Show compute attributes オブジェクト
  
  maxInstanceSize string
  
  Maximum instance size to which your cluster can automatically scale.
  
  Values are 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, or M600_NVME.
  
  minInstanceSize string
  
  Minimum instance size to which your cluster can automatically scale.
  
  Values are 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, or M600_NVME.
  
  diskTypeName string
  
  Azureインスタンスのホストのルートボリュームに対応するディスクの種類。省略した場合、選択した providerSettings.instanceSizeName のデフォルトのディスクタイプが適用されます。
  
  値は、P2、P3、P4、P6、P10、P15、P20、P30、P40、または P50 です。
  
  Disk type
  
  instanceSizeName string
  
  クラスター階層（デフォルトのストレージとメモリキャパシティー）で、クラスター内のすべてのデータ保持ホストに適用されます。
  
  Values are 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, or M600_NVME.
  
  regionName string
  
  Microsoft Azure Regions.
  
  値は 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、US_GOV_VIRGINIA、US_GOV_ARIZONA、または US_GOV_TEXAS 。
  
  Azure
  
  プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
  
  属性を非表示属性を表示
  
  providerName string 必須弁別子
  
  値は GCP です。
  
  autoScaling オブジェクト
  
  クラスターを増やすことができるインスタンスサイズの範囲。
  
  Hide autoScaling attribute Show autoScaling attribute オブジェクト
  
  compute オブジェクト
  
  Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
  
  Hide compute attributes Show compute attributes オブジェクト
  
  maxInstanceSize string
  
  Maximum instance size to which your cluster can automatically scale.
  
  値は M10、M20、M30、M40、M50、M60、M80、M140、M200、M250、M300、M400、 R40、R50、R60、R80、R200、R300、R400、R600、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、R200_GEN_2、R300_GEN_2、または R400_GEN_2
  
  minInstanceSize string
  
  Minimum instance size to which your cluster can automatically scale.
  
  値は M10、M20、M30、M40、M50、M60、M80、M140、M200、M250、M300、M400、 R40、R50、R60、R80、R200、R300、R400、R600、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、R200_GEN_2、R300_GEN_2、または R400_GEN_2
  
  instanceSizeName string
  
  クラスター階層（デフォルトのストレージとメモリキャパシティー）で、クラスター内のすべてのデータ保持ホストに適用されます。
  
  値は M10、M20、M30、M40、M50、M60、M80、M140、M200、M250、M300、M400、 R40、R50、R60、R80、R200、R300、R400、R600、M30_GEN_2、M40_GEN_2、M50_GEN_2、M60_GEN_2、M80_GEN_2、M140_GEN_2、M200_GEN_2、M300_GEN_2、R40_GEN_2、R50_GEN_2、R60_GEN_2、R80_GEN_2、R200_GEN_2、R300_GEN_2、または R400_GEN_2
  
  regionName string
  
  Google Compute Regions.
  
  Values are 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, or ASIA_SOUTHEAST_2.
  
  GCP
  
  プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
  
  属性を非表示属性を表示
  
  providerName string 必須弁別子
  
  値は TENANT です。
  
  autoScaling オブジェクト
  
  クラスターを増やすことができるインスタンスサイズの範囲。
  
  Hide autoScaling attribute Show autoScaling attribute オブジェクト
  
  compute オブジェクト
  
  Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.
  
  Hide compute attributes Show compute attributes オブジェクト
  
  maxInstanceSize string
  
  Maximum instance size to which your cluster can automatically scale.
  
  値は M0、M2、または M5 です。
  
  minInstanceSize string
  
  Minimum instance size to which your cluster can automatically scale.
  
  値は M0、M2、または M5 です。
  
  backingProviderName string
  
  MongoDB Cloud がマルチテナントホストをプロビジョニングしたクラウドサービスプロバイダー。リソースは、providerSettings.providerName が TENANT で、かつ providerSetting.instanceSizeName が M0、M2、または M5 の場合にこのパラメータを返します。
  
  M2 または M5 の instanceSize を使用すると、代わりに Flex クラスターが作成されることに注意してください。M2または M5 の instanceSize のサポートは 1 月 2026 で終了します。このような構成には、 Flex Cluster APIを使用することをお勧めします。
  
  値は AWS、GCP、または AZURE です。
  
  Flex Cluster API の作成
  
  automaticInstanceSizeName string
  
  true テナントインスタンスのサイズ。これは、非推奨のプロバイダータイプやインスタンスサイズの下位互換性をサポートするために存在します。
  
  値は、FLEX、M2、M5、または M0 です。
  
  instanceSizeName string
  
  クラスター階層（デフォルトのストレージとメモリキャパシティー）で、クラスター内のすべてのデータ保持ホストに適用されます。providerSettings.providerName を TENANT に設定し、providerSettings.backingProviderName にクラウドサービスプロバイダーを指定する必要があります。
  
  値は M0、M2、または M5 です。
  
  regionName string
  
  MongoDBクラスターの地理的ロケーションを識別する、人間が判読できるラベル。選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。リージョン名の完全なリストについては、AWS、GCP、Azureを参照してください。マルチリージョンクラスターについては、 replicationSpec.{region} を参照してください。
  
  プロビジョニングされた MongoDB ホストを構成するクラウドプロバイダー設定のグループ。
  
  属性を非表示属性を表示
  
  providerName string 必須弁別子
  
  値は FLEX です。
  
  backingProviderName string
  
  MongoDB Cloud がマルチテナントホストをプロビジョニングしたクラウドサービスプロバイダー。providerSettings.providerName が FLEX で、かつ providerSetting.instanceSizeName が FLEX の場合、リソースはこのパラメータを返します。
  
  値は AWS、GCP、または AZURE です。
  
  instanceSizeName string
  
  クラスター階層（デフォルトのストレージとメモリキャパシティー）で、クラスター内のすべてのデータ保持ホストに適用されます。providerSettings.providerName を FLEX に設定し、providerSettings.backingProviderName にクラウドサービスプロバイダーを指定する必要があります。
  
  値は FLEX です。
  
  regionName string
  
  Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.
- replicaSetScalingStratey string
  
  クラスターのレプリカセットスケーリングモードを構成するには、このフィールドをに設定します。
  
  デフォルトでは、Atlas は WORKLOAD_TYPE の下でスケーリングされます。このモードでは、Atlas は分析ノードを運用ノードと並行して増やすできます。
  
  SEQUENTIAL として構成すると、Atlas はすべてのノードを順次スケーリングします。このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。
  
  NODE_TYPE に設定すると、Atlas は選挙可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。このモードは、頻繁にクラスター階層を拡大することを必要とする大規模で動的ワークロードを対象としています。これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響可能性があります。
  
  値は SEQUENTIAL、WORKLOAD_TYPE、または NODE_TYPE です。デフォルト値は WORKLOAD_TYPE です。
  
  レプリカセットのスケーリングを変更...
- replicationFactor integer(int32) 非推奨
  
  レプリカセットに属するノードの数。各ノードはデータベースのコピーを保持し、高可用性とデータの冗長性を提供します。代わりに replicationSpecs を使用してください。
  
  値は 3、5、または 7 です。デフォルト値は 3 です。
- replicationSpec オブジェクト
  
  MongoDB Cloud がクラスターノードをプロビジョニングする物理的なロケーション。
  
  Hide replicationSpec attribute Show replicationSpec attribute オブジェクト
  
  * オブジェクト additionalProperties
  
  MongoDB Cloud がクラスターノードをプロビジョニングする物理的なロケーション。
  
  Hide * attributes Show * attributes オブジェクト
  
  analyticsNodes integer(int32)
  
  リージョン内の分析ノードの数。分析ノードは、MongoDB Cloud 上のMongoDB Connector for Business Intelligence からのクエリのレポート作成などの分析データを取り扱います。分析ノードは読み取り専用であり、プライマリになることはできません。代わりに replicationSpecs[n].{region}.analyticsNodes を使用してください。
  
  electableNodes integer(int32)
  
  指定されたリージョンに配置する選択可能なノードの数。選択可能なノードはプライマリになることができ、ローカル読み取りが容易になります。代わりに replicationSpecs[n].{region}.electableNodes を使用してください。
  
  値は、0、3、5、または 7 です。
  
  優先順位 integer(int32)
  
  Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to 7. The primary node runs in the Preferred Region. To identify a read-only region, set this parameter to 0.
  
  Minimum value is 0, maximum value is 7.
  
  readOnlyNodes integer(int32)
  
  リージョン内の読み取り専用ノードの数。読み取り専用ノードはプライマリノードになることはできませんが、ローカル読み取りを容易にできます。代わりに replicationSpecs[n].{region}.readOnlyNodes を使用してください。
- replicationSpecs array[オブジェクト]
  
  クラスターリージョンを構成する設定のリスト。
  
  グローバルクラスターの場合、配列内の各オブジェクトは、MongoDB Cloud がクラスターノードを配置する 1 つのゾーンを表します。
  
  非グローバルのシャーディングされたクラスターとレプリカセットの場合、1 つのオブジェクトは MongoDB Cloud がクラスターノードを配置する場所を表します。
  
  Hide replicationSpecs attributes Show replicationSpecs attributes オブジェクト
  
  id string
  
  Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.
  
  If you include existing zones in the request, you must specify this parameter.
  
  If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.
  
  形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
  
  numShards integer(int32)
  
  指定された各ゾーンに配置するシャードの数を指定する正の整数。この値を 1 に設定し、clusterType が SHARDED の場合、 MongoDB Cloud は単一シャードのシャーディングされたクラスターを配置します。実稼働環境では、単一のシャードを含むシャーディングされたクラスターを作成しないでください。単一シャードのシャードクラスターでは、マルチシャード構成と同じ利点は得られません。
  
  If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.
  
  デフォルト値は1です。
  
  regionsConfig オブジェクト
  
  MongoDB Cloud がクラスターノードをプロビジョニングする物理的なロケーション。
  
  Hide regionsConfig attribute Show regionsConfig attribute オブジェクト
  
  * オブジェクト additionalProperties
  
  MongoDB Cloud がクラスターノードをプロビジョニングする物理的なロケーション。
  
  Hide * attributes Show * attributes オブジェクト
  
  analyticsNodes integer(int32)
  
  リージョン内の分析ノードの数。分析ノードは、MongoDB Cloud 上のMongoDB Connector for Business Intelligence からのクエリのレポート作成などの分析データを取り扱います。分析ノードは読み取り専用であり、プライマリになることはできません。代わりに replicationSpecs[n].{region}.analyticsNodes を使用してください。
  
  electableNodes integer(int32)
  
  指定されたリージョンに配置する選択可能なノードの数。選択可能なノードはプライマリになることができ、ローカル読み取りが容易になります。代わりに replicationSpecs[n].{region}.electableNodes を使用してください。
  
  値は、0、3、5、または 7 です。
  
  優先順位 integer(int32)
  
  Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to 7. The primary node runs in the Preferred Region. To identify a read-only region, set this parameter to 0.
  
  Minimum value is 0, maximum value is 7.
  
  readOnlyNodes integer(int32)
  
  リージョン内の読み取り専用ノードの数。読み取り専用ノードはプライマリノードになることはできませんが、ローカル読み取りを容易にできます。代わりに replicationSpecs[n].{region}.readOnlyNodes を使用してください。
  
  zoneName string
  
  グローバルクラスター内のゾーンを識別する、人間が判読できるラベル。この値は、clusterType が GEOSHARDED の場合にのみ指定します。
- rootCertType string
  
  MongoDB Atlasクラスターが使用するルート認証局。MongoDB Cloud は Internet Research Group をサポートしています。
  
  値は ISRGROOTX1 です。デフォルト値は ISRGROOTX1 です。
- srvAddress string
  
  Connection string that you can use to connect to the cluster. The +srv modifier forces the connection to use Transport Layer Security (TLS). The mongoURI parameter lists additional options.
  
  接続文字列 URI 形式。
- StateName string
  
  Atlas コントロールプレーンによってこのクラスターで実行されている現在のアクティビティを示す、人間が判読可能なラベル。CR表現と削除がノードな状態を除く
  
  IDLE: Atlas はこのクラスターに変更を加えず、 UIまたはAPI経由でリクエストされたすべての変更が適用されたと想定できます。
  
  CREATING: 初めてプロビジョニングされたクラスターは、接続の準備が整うまで状態が CRUDING を返します。接続を試みる前に、 IPアクセスリストと DB ユーザーが設定されていることを確認します。
  
  UPDATING: UI、 API、AutoScaling、またはその他のスケジュールされたアクティビティからリクエストされた変更が実行されています。
  
  DELETING: クラスターは削除プロセス中であり、すぐに削除される予定です。
  
  REPAIRING: クラスター内の 1 つ以上のノードが Atlas コントロールプレーンによって使用可能に返されています。他のノードは、通常どおりサービスを提供し続ける必要があります。
  
  値は、IDLE、CREATING、UPDATING、DELETING、または REPAIRING です。
- tags array[オブジェクト]
  
  クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。
  
  Resource Tags
  
  Hide tags attributes Show tags attributes オブジェクト
  
  Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, environment : production.
  
  キー string 必須
  
  タグのセットを定義する定数。たとえば、 environment : productionタグ内のenvironment 。
  
  Minimum length is 1, maximum length is 255.
  
  価値 string 必須
  
  タグのセットに属する変数。たとえば、 environment : productionタグ内のproduction 。
  
  Minimum length is 1, maximum length is 255.
- terminationProtectionEnabled ブール値
  
  クラスターで終了保護が有効になっているかどうかを示すフラグ。true に設定されていると、MongoDB Cloud はクラスターを削除しません。false に設定されていると、MongoDB Cloud はクラスターを削除します。
  
  デフォルト値はfalseです。
- versionReleaseSystem string
  
  クラスターがMongoDB のバージョンを管理する方法。値が CONTINUOUS の場合、mongoDBMajorVersion を指定しないでください。
  
  値は LTS または CONTINUOUS です。デフォルト値は LTS です。
400 application/ JSON

無効なリクエストです。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string | null
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string | null
  
  このエラーで返されたアプリケーションエラーメッセージ。
401 application/ JSON

許可されていません。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string | null
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string | null
  
  このエラーで返されたアプリケーションエラーメッセージ。
402 application/ JSON

支払いが必要です。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string | null
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string | null
  
  このエラーで返されたアプリケーションエラーメッセージ。
403 application/ JSON

Forbidden.
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string | null
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string | null
  
  このエラーで返されたアプリケーションエラーメッセージ。
404 application/ JSON

見つかりません。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string | null
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string | null
  
  このエラーで返されたアプリケーションエラーメッセージ。
409 application/ JSON

競合。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string | null
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string | null
  
  このエラーで返されたアプリケーションエラーメッセージ。
500 application/ JSON

内部サーバーエラー。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string | null
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string | null
  
  このエラーで返されたアプリケーションエラーメッセージ。

POST /API/Atlas/v1.0/groups/{groupId}/clusters/tenantアップグレード

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/tenantUpgrade' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "acceptDataRisksAndForceReplicaSetReconfig": "2026-05-04T09:42:00Z",
  "advancedConfiguration": {
    "customOpensslCipherConfigTls12": [
      "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
    ],
    "customOpensslCipherConfigTls13": [
      "TLS_AES_256_GCM_SHA384"
    ],
    "minimumEnabledTlsProtocol": "TLS1_0",
    "tlsCipherConfigMode": "CUSTOM"
  },
  "autoScaling": {
    "compute": {
      "enabled": false,
      "scaleDownEnabled": false
    },
    "diskGBEnabled": false
  },
  "backupEnabled": true,
  "biConnector": {
    "enabled": true,
    "readPreference": "PRIMARY"
  },
  "clusterType": "REPLICASET",
  "configServerManagementMode": "ATLAS_MANAGED",
  "deleteAfterCreationHours": 42,
  "diskSizeGB": 42.0,
  "diskWarmingMode": "FULLY_WARMED",
  "encryptionAtRestProvider": "NONE",
  "globalClusterSelfManagedSharding": true,
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "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": "2026-05-04T09:42:00Z",
  "advancedConfiguration": {
    "customOpensslCipherConfigTls12": [
      "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
    ],
    "customOpensslCipherConfigTls13": [
      "TLS_AES_256_GCM_SHA384"
    ],
    "minimumEnabledTlsProtocol": "TLS1_0",
    "tlsCipherConfigMode": "CUSTOM"
  },
  "autoScaling": {
    "compute": {
      "enabled": false,
      "scaleDownEnabled": false
    },
    "diskGBEnabled": false
  },
  "backupEnabled": true,
  "biConnector": {
    "enabled": true,
    "readPreference": "PRIMARY"
  },
  "clusterType": "REPLICASET",
  "configServerManagementMode": "ATLAS_MANAGED",
  "deleteAfterCreationHours": 42,
  "diskSizeGB": 42.0,
  "diskWarmingMode": "FULLY_WARMED",
  "encryptionAtRestProvider": "NONE",
  "globalClusterSelfManagedSharding": true,
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "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"
}

応答の例（200）

{
  "acceptDataRisksAndForceReplicaSetReconfig": "2026-05-04T09:42:00Z",
  "advancedConfiguration": {
    "customOpensslCipherConfigTls12": [
      "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
    ],
    "customOpensslCipherConfigTls13": [
      "TLS_AES_256_GCM_SHA384"
    ],
    "minimumEnabledTlsProtocol": "TLS1_0",
    "tlsCipherConfigMode": "CUSTOM"
  },
  "autoScaling": {
    "compute": {
      "enabled": 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": "2026-05-04T09:42:00Z",
  "deleteAfterCreationHours": 42,
  "deleteAfterDate": "2026-05-04T09:42:00Z",
  "diskSizeGB": 42.0,
  "diskWarmingMode": "FULLY_WARMED",
  "encryptionAtRestProvider": "NONE",
  "featureCompatibilityVersion": "string",
  "featureCompatibilityVersionExpirationDate": "2026-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": "2026-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": "2026-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"
}

応答の例（400）

{
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "error": 400,
  "errorCode": "VALIDATION_ERROR",
  "reason": "Bad Request"
}

応答の例（401）

{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}

応答の例（402）

{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 402,
  "errorCode": "NO_PAYMENT_INFORMATION_FOUND",
  "reason": "Payment Required"
}

応答の例（403）

{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}

応答の例（404）

{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}

応答の例（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",
  "error": 409,
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK",
  "reason": "Conflict"
}

応答の例（500）

{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}