1 つの共有階層クラスターのアップグレード
指定されたプロジェクトの共有階層クラスターを Flex または専有（M10+）クラスターにアップグレードします。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーのロールが必要です。各プロジェクトは最大 25 クラスターに対応します。
このエンドポイントは、 createCluster APIを使用して作成された Flex クラスター、または2 5Flex クラスターに移行された以前の M /M クラスターをアップグレードするためにも使用できます。これは instanceSizeName を2 M または M{6} 1 月2026 までの「 」。この機能は 年 1 月2026 日まで使用でき、その後は M0 クラスターでのみ使用できます。代わりに、アップグレード FlexCluster エンドポイントを使用してください。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
指定されたプロジェクト内の共有階層クラスターのアップグレードの詳細。
-
リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み（過半数がコミットされた書込みであっても）が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。 このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
リージョン停止時のレプリカセットの再構成 -
高度な構成の詳細のサブセットを構成する設定のグループ。
-
クラスターを増やすことができるインスタンス サイズの範囲。
クラスターの自動スケーリング -
クラスターがバックアップを実行できるかどうかを示すフラグ。
trueに設定されていると、クラスターはバックアップを実行できます。NVMe クラスターの場合、この値をtrueに設定する必要があります。バックアップは、専用クラスターにはクラウドバックアップを使用し、テナントクラスターには共有クラスターバックアップを使用します。falseに設定されていると、クラスターは MongoDB Cloud バックアップを使用しません。 -
このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。
MongoDB Connector for Business Intelligence -
クラスターを構成するノードの構成。
値は
REPLICASET、SHARDED、またはGEOSHARDEDです。 -
シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバー マネジメント モード。
ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスとコスト削減のために、クラスターのコンフィギュレーションサーバーの種類を自動的に切り替える場合があります。
FIXED_TO_DEDICATED として構成すると、クラスターは常に専用のコンフィギュレーションサーバーを使用します。
値は
ATLAS_MANAGEDまたはFIXED_TO_DEDICATEDです。デフォルト値はATLAS_MANAGEDです。MongoDB シャーディングされたクラスターのコンフィギュレーション サーバー -
インスタンス データ ボリュームのストレージ容量（ギガバイト単位）。 この数を増やすと、容量が追加されます。
この値は、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 コンポーネントに適用された、人間が判読可能なラベル。
Resource Tags -
MongoDB 従業員に付与されるクラスターのアクセスレベルと有効期限。
-
クラスターの MongoDB メジャー バージョン。
作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョン エンドポイントの API エンドポイントを使用してください。
更新時: 一度に1メジャー バージョンを つだけ上げてください。 クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。
Atlas で利用可能な 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 バックアップを使用しません。 -
クラスターのレプリカセット スケーリング モードを構成するには、このフィールドを に設定します。
デフォルトでは、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 がクラスター ノードを配置する 1 つのゾーンを表します。
- 非グローバルのシャーディングされたクラスターとレプリカセットの場合、1 つのオブジェクトは MongoDB Cloud がクラスター ノードを配置する場所を表します。
-
MongoDB Atlasクラスターが使用するルート認証局。MongoDB Cloud は Internet Research Group をサポートしています。
値は
ISRGROOTX1です。デフォルト値はISRGROOTX1です。 -
クラスターで終了保護が有効になっているかどうかを示すフラグ。
trueに設定されていると、MongoDB Cloud はクラスターを削除しません。falseに設定されていると、MongoDB Cloud はクラスターを削除します。デフォルト値は
falseです。 -
クラスターが MongoDB のバージョンを管理する方法。値が
CONTINUOUSの場合、mongoDBMajorVersion を指定しないでください。値は
LTSまたはCONTINUOUSです。デフォルト値はLTSです。
atlas api clusters upgradeGroupClusterTenantUpgrade --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250219001/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.UpgradeGroupClusterTenantUpgradeApiParams{}
sdkResp, httpResp, err := client.ClustersApi.
UpgradeGroupClusterTenantUpgradeWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-02-19+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 --include \
--header "Accept: application/vnd.atlas.2025-02-19+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"
}