リージョン化されたプライベートエンドポイントのステータスを切り替える
1 つのプロジェクトのすべてのクラウドサービスプロバイダーで、1 つのリージョンにつき複数のプライベートエンドポイントを作成できる機能を有効または無効にします。クラウド サービス プロバイダーがプロジェクトのプライベートエンドポイントを管理します。この設定を有効にすると、既存のマルチリージョンおよびグローバルのシャーディングされたクラスターへの接続文字列が変更されます。新しい接続文字列を使用するには、アプリケーションをアップデートする必要があります。これにより、ダウンタイムが発生する可能性があります。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーのロールがあり、配置内のすべてのクラスターがシャーディングされたクラスターである必要があります。有効にすると、レプリカセットは作成できなくなります。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
1 つのプロジェクトのすべてのクラウドサービスプロバイダーで、1 つのリージョンにつき複数のプライベートエンドポイントを作成できる機能を有効または無効にします。
-
指定されたプロジェクトで、リージョン化されたプライベートエンドポイント設定が有効にされているかどうかを示すフラグ。
リージョン化されたプライベート エンドポイントを有効にするには、この値を
trueに設定します。これにより、1 つのクラウドプロバイダー リージョンに複数のプライベート エンドポイントを作成できます。マルチリージョンおよびグローバルのシャーディングされたMongoDB Cloud クラスターに接続するには、この設定を有効にする必要があります。リージョン化されたプライベート エンドポイントを有効にすると、次の制限が発生します。- アプリケーションでは、既存のマルチリージョンおよびグローバルのシャーディングされたクラスターに新しい接続文字列を使用する必要があります。これにより、ダウンタイムが発生する可能性があります。
- MongoDB Cloud プロジェクトにレプリカ セットを含めることはできません。また、このプロジェクトに新しいレプリカセットを作成することもできません。
- 次の場合は、この設定を無効にすることはできません。
- 複数のリージョンに複数のプライベートエンドポイント
- 1 つのリージョンに複数のプライベートエンドポイントがあり、1 つ以上のリージョンに 1 つのプライベートエンドポイントがあります。
リージョン化されたプライベートエンドポイントを無効にするには、この値を
falseに設定します。
atlas api privateEndpointServices toggleGroupPrivateEndpointRegionalMode --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241023001/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.ToggleGroupPrivateEndpointRegionalModeApiParams{}
sdkResp, httpResp, err := client.PrivateEndpointServicesApi.
ToggleGroupPrivateEndpointRegionalModeWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \
-d '{ <Payload> }'{
"enabled": true
}{
"enabled": true
}{
"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": 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"
}