Habilita o deshabilita la posibilidad de crear múltiples puntos de conexión privados por región en todos los proveedores de servicios en la nube de un proyecto. El proveedor de servicios en la nube administra los puntos de conexión privados del proyecto. Las cadenas de conexión a clústeres multirregionales y globales fragmentados existentes cambian al habilitar esta configuración. Debe actualizar sus aplicaciones para usar las nuevas cadenas de conexión. Esto podría causar tiempo de inactividad. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de propietario del proyecto y todos los clústeres de la implementación deben ser clústeres fragmentados. Una vez habilitado, no se pueden crear conjuntos de réplicas.
Parámetros de ruta
-
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita
Cuerpo
Requerido
Habilita o deshabilita la capacidad de crear múltiples puntos finales privados por región en todos los proveedores de servicios en la nube en un proyecto.
-
Bandera que indica si alguien habilitó la configuración de punto final privado regionalizado para el proyecto especificado.
Establezca este valor en
truepara habilitar los endpoints privados regionalizados. Esto le permite crear más de un endpoint privado en una región de proveedor de nube. Debe habilitar esta configuración para conectarse a clústeres fragmentados de MongoDB Cloud multirregionales y globales. La habilitación de endpoints privados regionalizados presenta las siguientes limitaciones:- Sus aplicaciones deben usar las nuevas cadenas de conexión para los clústeres multirregionales y globales fragmentados existentes. Esto podría causar tiempo de inactividad.
- Su proyecto MongoDB Cloud no puede contener conjuntos de réplicas ni puede crear nuevos conjuntos de réplicas en este proyecto.
- No puede desactivar esta configuración si tiene:
- más de un punto final privado en más de una región
- más de un punto final privado en una región y un punto final privado en una o más regiones.
Establezca este valor en
falsepara deshabilitar los puntos finales privados regionalizados.
atlas api privateEndpointServices toggleRegionalEndpointMode --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.ToggleGroupPrivateEndpointRegionalModeApiParams{}
sdkResp, httpResp, err := client.PrivateEndpointServicesApi.
ToggleGroupPrivateEndpointRegionalModeWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-05-30+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-05-30+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"
}