Criar um namespace gerenciado em um cluster global
Cria um namespace gerenciado dentro do cluster global especificado. Um namespace gerenciado identifica uma coleção utilizando o nome do banco de dados, o separador de pontos e o nome da coleção. Para utilizar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de administrador de acesso aos dados do projeto. Versões obsoletas: v2-{2023-02-01}, v2-{2023-01-01}
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})$. -
Etiqueta legível para humanos que identifica este cluster.
O formato deve corresponder ao seguinte padrão:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
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
Namespace gerenciado a ser criado dentro do cluster global especificado.
-
Rótulo legível por humanos da coleção a ser gerenciada para esse cluster global.
-
Parâmetro do banco de dados utilizado para dividir a coleção em fragmentos. Clusters globais exigem uma chave de shard composta. Essa chave de shard composta combina o parâmetro de localização e a chave personalizada selecionada pelo usuário.
-
Etiqueta legível para humanos do banco de dados a ser gerenciado para este cluster global.
-
Sinalizador que indica se alguém fez hash da chave de shard personalizada para a collection especificada. Se você definir esse valor como
false, o MongoDB cloud usará fragmentação à distância.O valor padrão é
false.Hashed shard keys -
Sinalizador que indica se alguém fez hash da chave de shard personalizada. Se esse parâmetro
falseretornar, esse cluster usará fragmentação à distância.O valor padrão é
false. -
Número mínimo de chunks a serem criados inicialmente ao fragmentar uma coleção vazia com uma chave de fragmento com hash .
O valor máximo é
8192.Fragmentação de cluster global -
Sinalizador que indica se o MongoDB Cloud deve criar e distribuir chunks iniciais para uma collection vazia ou inexistente. O MongoDB Cloud distribui dados com base nas zonas e faixas de zonas definidos para a collection.
O valor padrão é
false.Chave de fragmento com hash
atlas api globalClusters createGroupClusterGlobalWriteManagedNamespace --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.CreateGroupClusterGlobalWriteManagedNamespaceApiParams{}
sdkResp, httpResp, err := client.GlobalClustersApi.
CreateGroupClusterGlobalWriteManagedNamespaceWithParams(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 POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \
-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 POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \
-d '{ <Payload> }'{
"collection": "string",
"customShardKey": "string",
"db": "string",
"isCustomShardKeyHashed": false,
"isShardKeyUnique": false,
"numInitialChunks": 42,
"presplitHashedZones": false
}{
"customZoneMapping": {
"additionalProperty1": "32b6e34b3d91647abb20e7b8",
"additionalProperty2": "32b6e34b3d91647abb20e7b8"
},
"managedNamespaces": [
{
"collection": "string",
"customShardKey": "string",
"db": "string",
"isCustomShardKeyHashed": false,
"isShardKeyUnique": false,
"numInitialChunks": 42,
"presplitHashedZones": false
}
],
"selfManagedSharding": true
}{
"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": 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": 405,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Method Not Allowed",
"errorCode": "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}