Alternar status de endpoint privado regionalizado
Habilite ou desabilite a capacidade de criar vários pontos de extremidade privados por região em todos os fornecedores de serviços de nuvem em um projeto. O provedor de serviços em nuvem gerencia os pontos de extremidade privados do projeto. As strings de conexão com clusters fragmentados globais e multirregionais existentes são alteradas quando você habilita essa configuração. Você deve atualizar seus aplicativos para usar as novas strings de conexão. Isso pode causar tempo de inatividade. Para usar este recurso, a conta de serviço ou chave de API solicitante deve ter a função Proprietário do projeto e todos os clusters na implantação devem ser clusters fragmentados. Depois de habilitado, você não pode criar conjuntos de réplicas.
parâmetros de caminho
-
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
corpo, corpo
Obrigatório
Habilite ou desabilite a capacidade de criar vários pontos de extremidade privados por região em todos os fornecedores de serviços de nuvem em um projeto.
-
Sinalizador que indica se alguém habilitou a configuração de ponto de extremidade privado regionalizado para o projeto especificado.
Configure este valor para
truepara habilitar pontos de extremidade privados regionalizados. Isso permite criar mais de um ponto de extremidade privado em uma região de provedor de nuvem. Você precisa habilitar essa configuração para se conectar a clusters fragmentados globais e multirregionais do MongoDB Cloud. Habilitar pontos de extremidade privados regionalizados introduz as seguintes limitações:- Seus aplicativos devem usar as novas cadeias de conexão para clusters fragmentados globais e multirregionais existentes. Isso pode causar tempo de inatividade.
- Seu projeto MongoDB Cloud não pode conter conjuntos de réplicas nem você pode criar novos conjuntos de réplicas neste projeto.
- Não é possível desativar essa configuração se você tiver:
- mais de um ponto de extremidade privado em mais de uma região
- mais de um ponto de extremidade privado em uma região e um ponto de extremidade privado em uma ou mais regiões.
Configure este valor como
falsepara desabilitar pontos de extremidade privados regionalizados.
atlas api privateEndpointServices toggleGroupPrivateEndpointRegionalMode --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/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.2025-03-12+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.2025-03-12+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"
}