リージョン化されたプライベートエンドポイントのステータスを切り替える

PATCH /api/atlas/v1.0/groups/{groupId}/privateEndpoint/regionalMode

1 つのプロジェクトのすべてのクラウドサービスプロバイダーで、1 つのリージョンにつき複数のプライベートエンドポイントを作成できる機能を有効または無効にします。クラウドサービスプロバイダーがプロジェクトのプライベートエンドポイントを管理します。この設定を有効にすると、既存のマルチリージョンおよびグローバルのシャーディングされたクラスターへの接続文字列が変更されます。新しい接続文字列を使用するには、アプリケーションをアップデートする必要があります。これにより、ダウンタイムが発生する可能性があります。このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーにプロジェクトオーナーのロールがあり、配置内のすべてのクラスターがシャーディングされたクラスターである必要があります。有効にすると、レプリカセットは作成できなくなります。

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 必須

1 つのプロジェクトのすべてのクラウドサービスプロバイダーで、1 つのリージョンにつき複数のプライベートエンドポイントを作成できる機能を有効または無効にします。

enabled ブール値必須
指定されたプロジェクトで、リージョン化されたプライベートエンドポイント設定が有効にされているかどうかを示すフラグ。
- リージョン化されたプライベートエンドポイントを有効にするには、この値をtrueに設定します。これにより、1 つのクラウドプロバイダーリージョンに複数のプライベートエンドポイントを作成できます。マルチリージョンおよびグローバルのシャーディングされたMongoDB Cloud クラスターに接続するには、この設定を有効にする必要があります。リージョン化されたプライベートエンドポイントを有効にすると、次の制限が発生します。
  - アプリケーションでは、既存のマルチリージョンおよびグローバルのシャーディングされたクラスターに新しい接続文字列を使用する必要があります。これにより、ダウンタイムが発生する可能性があります。
  - MongoDB Cloud プロジェクトにレプリカセットを含めることはできません。また、このプロジェクトに新しいレプリカセットを作成することもできません。
  - 次の場合は、この設定を無効にすることはできません。
  - 複数のリージョンに複数のプライベートエンドポイント
  - 1 つのリージョンに複数のプライベートエンドポイントがあり、1 つ以上のリージョンに 1 つのプライベートエンドポイントがあります。
- リージョン化されたプライベートエンドポイントを無効にするには、この値をfalseに設定します。

応答

200 application/ JSON

OK
応答属性を非表示応答属性の表示オブジェクト
- enabled ブール値必須
  
  指定されたプロジェクトで、リージョン化されたプライベートエンドポイント設定が有効にされているかどうかを示すフラグ。
  
  リージョン化されたプライベートエンドポイントを有効にするには、この値をtrueに設定します。これにより、1 つのクラウドプロバイダーリージョンに複数のプライベートエンドポイントを作成できます。マルチリージョンおよびグローバルのシャーディングされたMongoDB Cloud クラスターに接続するには、この設定を有効にする必要があります。リージョン化されたプライベートエンドポイントを有効にすると、次の制限が発生します。
  
  アプリケーションでは、既存のマルチリージョンおよびグローバルのシャーディングされたクラスターに新しい接続文字列を使用する必要があります。これにより、ダウンタイムが発生する可能性があります。
  
  MongoDB Cloud プロジェクトにレプリカセットを含めることはできません。また、このプロジェクトに新しいレプリカセットを作成することもできません。
  
  次の場合は、この設定を無効にすることはできません。
  
  複数のリージョンに複数のプライベートエンドポイント
  
  1 つのリージョンに複数のプライベートエンドポイントがあり、1 つ以上のリージョンに 1 つのプライベートエンドポイントがあります。
  
  リージョン化されたプライベートエンドポイントを無効にするには、この値をfalseに設定します。
401 application/ JSON

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

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

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

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

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

PATCH /API/Atlas/v1.0/groups/{groupId}/privateEndpoint/regionalMode

curl \
 --request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/privateEndpoint/regionalMode' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"enabled":true}'

リクエスト例

{
  "enabled": true
}

応答の例（200）

{
  "enabled": true
}

応答の例（401）

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

応答の例（403）

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

応答の例（404）

{
  "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"
}

応答の例（409）

{
  "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"
}

応答の例（500）

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