Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs

Criar um Atlas cluster efêmero

Construa e teste com o MongoDB usando um Atlas Ephemeral cluster, um cluster gratuito temporário (M0) que você pode criar e se conectar sem uma conta Atlas ou chaves de API. Um cluster efêmero é uma boa opção quando um agente de codificação de IA ou um desenvolvedor que trabalha com um precisa de um banco de dados sob demanda para iniciar um novo projeto, criar um protótipo de aplicação ou testar uma ideia.

Para criar um cluster efêmero e obter uma string de conexão pronta para uso em menos de um minuto, envie uma solicitação POST para o seguinte endpoint:

https://cloud.mongodb.com/api/atlas/v2/unauth/ephemeralClusters:create

Para obter o fluxo de trabalho completo, os cabeçalhos necessários e os detalhes de resposta,consulte o Início rápido.

A menos que você reivindique o cluster efêmero, o Atlas o pausará 2 dias após a criação e o excluirá 7 dias após a criação. Para solicitar o cluster, abra o claimUrl da resposta de criação e entre no Atlas. A reivindicação converte o cluster efêmero em um cluster gratuito padrão sem data de expiração. Um agente pode criar e se conectar ao cluster de forma autônoma, mas apenas um ser humano pode reivindicá-lo.

Um cluster efêmero é um cluster gratuito do Atlas (M0) com uma duração limitada. Para ler e gravar seus dados, você pode se conectar ao cluster com a string de conexão retornada pela resposta de criação. Até que você reivindique o cluster, não poderá escalar a camada do cluster, adicionar usuários do banco de dados , restringir o acesso IP ou executar outras operações administrativas.

Um cluster efêmero não declarado tem as seguintes especificações fixas:

  • Camada do cluster: Gratuito (M0).

  • Provedor de nuvem e região: AWS us-east-1.

  • Acesso IP: o cluster permite conexões de qualquer endereço IP (0.0.0.0/0).

  • Vida útil limitada: a menos que você reivindique o cluster, o Atlas o pausará 2 dias após a criação e o excluirá 7 dias após a criação. Enquanto pausado, o cluster fica inacessível.

Como um cluster efêmero é um cluster gratuito, todos os limites do cluster gratuito também se aplicam, incluindo:

  • Armazenamento: máximo de 512 MB, incluindo índices.

  • Versão do servidor MongoDB: 8.0.

  • Taxa de transferência: máximo de 100 operações de leitura e escrita por segundo.

  • Conexões: máximo de 500 conexões simultâneas.

Para obter a lista completa de limitações de cluster gratuitas, consulte Limites de cluster gratuito do Atlas .

Use o seguinte fluxo de trabalho para criar e conectar-se a um cluster efêmero. Um agente de codificação de IA pode concluir cada etapa desse fluxo de trabalho sem intervenção humana.

1

Envie uma solicitação POST para o seguinte endpoint:

https://cloud.mongodb.com/api/atlas/v2/unauth/ephemeralClusters:create

A solicitação requer o seguinte cabeçalho Accept:

Accept: application/vnd.atlas.preview+json

O seguinte exemplo de solicitação cria um cluster efêmero denominado Cluster0:

Exemplo de solicitação de criação
curl -sS -X POST 'https://cloud.mongodb.com/api/atlas/v2/unauth/ephemeralClusters:create' \
-H 'Accept: application/vnd.atlas.preview+json' \
-H 'Content-Type: application/json' \
-d '{"clusterName": "Cluster0"}'

O endpoint de criação retorna uma resposta no seguinte formato:

Exemplo de criação de resposta
{
"claimUrl": "https://account.mongodb.com/account/register?claimId={claimId}",
"clusterId": "{clusterId}",
"connectionString": "mongodb+srv://{username}:{password}@{host}/",
"expiresAt": "{timestamp}",
"status": "PROVISIONING",
"termsOfService": "By using this API and any resources provisioned through it, you agree to be bound by MongoDB's Cloud Terms of Service at https://www.mongodb.com/legal/terms-and-conditions/cloud; and Privacy Policy at https://www.mongodb.com/legal/privacy/privacy-policy."
}

A resposta inclui os seguintes campos:

  • claimUrl: URL exclusiva para reivindicação deste cluster efêmero. Um ser humano deve abrir esta URL em um navegador. Válido por 7 dias após a criação do cluster.

  • clusterId: Identificador único do cluster Efêmero. Para recuperar o status, claimUrl e outros detalhes do cluster, envie uma solicitação de GET para o seguinte endpoint, substituindo {clusterId} por esse valor:

    https://cloud.mongodb.com/api/atlas/v2/unauth/ephemeralClusters/{clusterId}

    Para saber mais,consulte Retornar um cluster efêmero do Atlas .

  • connectionString: connection string que usa o protocolo mongodb+srv:// para se conectar ao cluster efêmero. Inclui o nome de usuário e a senha de um usuário de banco de dados gerado automaticamente que pode ler e gravar dados no cluster. Qualquer cliente que use essa string de conexão se autentica como esse usuário de banco de dados. A resposta de criação é a única vez que o Atlas retorna a senha não editada.

  • expiresAt: Data e hora em que o Atlas pausa o cluster se ele não for solicitado. Um cluster efêmero pausado fica inacessível até que você o reivindique. O carimbo de data/hora usa o formato ISO 8601 em UTC.

  • status: Status do cluster efêmero. Um entre PROVISIONING, ACTIVE ou PAUSED.

  • termsOfService: observe que, ao usar essa API, você concorda com os Termos de Serviço e a Política de Privacidade da Nuvem do MongoDB. Inclui um link para os termos completos.

Para saber mais sobre o endpoint de criação, consulte Criar um cluster efêmero do Atlas .

2

Na resposta de criação, salve o connectionString, claimUrl e clusterId. Você precisa deles para se conectar, exigir e recuperar os detalhes do cluster.

Aviso

Trate connectionString, claimUrl e clusterId como segredos. Qualquer pessoa com o connectionString pode ler e escrever dados de cluster. Qualquer pessoa com o claimUrl pode declarar o cluster em sua própria conta do Atlas , e qualquer pessoa com o clusterId pode recuperar o claimUrl do endpoint de obtenção. OSuporte do MongoDB não pode recuperar esses valores ou transferir a propriedade de um cluster declarado.

Salve todos os três valores em um local seguro onde a pessoa que solicita o cluster possa recuperá-los. Por exemplo, use um gerenciador de segredos compartilhados ou um arquivo .env local ignorado por git. Não substitua segredos existentes nesse local.

3

Use o valor connectionString da resposta de criação para se conectar ao cluster efêmero a partir de um ambiente compatível, como:

  • Código do aplicativo: forneça a string de conexão ao driver MongoDB para sua linguagem de programação quando você inicializar o objeto do cliente que se conecta ao cluster. Essa é a escolha típica ao se conectar a partir de um aplicação. Para saber mais, consulte Conectar-se a um cluster por meio de bibliotecas de clientes.

  • Linha de comando: forneça a string de conexão como um argumento para o MongoDB Shell (mongosh) para conectar e executar comandos interativamente:

    Exemplo de conexão da linha de comando
    mongosh "<connectionString>"

Para saber mais sobre os métodos de conexão disponíveis, consulte Considerações.

Observação

O cluster efêmero permite conexões de qualquer endereço IP (0.0.0.0/0). Você pode restringir o acesso IP ao solicitar o cluster.

4

Reivindicar o cluster efêmero é opcional. Se você não exigir o cluster, o Atlas pausará 2 dias após a criação e o excluirá 7 dias após a criação. Quando você solicita o cluster, o Atlas o converte em um cluster gratuito padrão sem data de expiração. O cluster reivindicação mantém todos os seus dados e a string de conexão que você salvou continua a funcionar com as mesmas credenciais. Para saber mais sobre os efeitos da reivindicação, consulte Reivindicar um cluster efêmero.

Para solicitar o cluster, um ser humano deve se conectar ao Atlas em um navegador. Escolha uma das seguintes opções:

  • Reclamar agora: partilhe o claimUrl apenas com a pessoa que exigirá o cluster. Eles podem seguir o procedimento em Reivindicar um cluster efêmero para solicitar o cluster.

  • Reclamar mais tarde: Salve o claimUrl em um local seguro que permaneça disponível para a pessoa que solicitará o cluster. Essa pessoa pode então exigir o cluster a qualquer momento dentro de 7 dias após a criação.

  • Declarar nunca: não realizar nenhuma ação. O Atlas exclui o cluster 7 dias após a criação.

Reivindicar um cluster efêmero é opcional. Se você não exigir o cluster, o Atlas pausará 2 dias após a criação e o excluirá 7 dias após a criação.

Quando você solicita um cluster efêmero, o Atlas faz as seguintes alterações:

  • Prolonga a vida útil do cluster: o Atlas converte o cluster efêmero em um cluster gratuito padrão sem data de expiração. O cluster solicitado permanece disponível até que você o exclua ou até que o Atlas o pause devido a 30 dias de inatividade.

  • Preserva a string de conexão e os dados do cluster: o cluster reivindicação mantém todos os seus dados e a string de conexão da resposta de criação continua a funcionar com as mesmas credenciais.

  • Adiciona o cluster a um projeto e organização: No Atlas, cada cluster pertence a um projeto, e cada projeto pertence a uma organização. O Atlas coloca o cluster reivindicação em um novo projeto dentro de uma organização nova ou existente de propriedade da conta que solicita o cluster.

  • Concede acesso total ao cluster: a conta que afirma que o cluster é um Organization Owner da organização do cluster , que também concede a função Project Owner em cada projeto nessa organização. Como Proprietário do Projeto, você tem acesso ao banco de dados para ler e escrever os dados do cluster, e acesso administrativo para gerenciar o cluster e seu projeto usando a UI do Atlas , a Atlas CLI ou a API de Administração do Atlas .

Um agente de codificação de IA não pode invocar um cluster efêmero. Para solicitar o cluster, um ser humano deve concluir o seguinte fluxo de trabalho em um navegador da Web:

1
  1. Em um navegador da web, abra o claimUrl que você salvou da criação da resposta para acessar a página de login do Atlas . O URL de reivindicação tem o seguinte formato, onde {claimId} é um identificador único para o agrupamento efêmero:

    https://account.mongodb.com/account/register?claimId={claimId}

  2. Na página de entrada, entre no Atlas com uma conta existente ou crie uma nova conta. Quando você solicita o cluster na próxima etapa, essa conta obtém acesso administrativo e de banco de dados ao cluster.

    Se você criar uma nova conta, verifique seu e-mail antes de continuar.

Observação

A URL de reivindicação é a única maneira de reivindicação do cluster. Expira 7 dias após a criação do cluster. Se você perder o URL de reivindicação , recupere-o com um dos métodos a seguir:

  • Envie uma solicitação GET para o seguinte endpoint, substituindo {clusterId} pelo valor clusterId da resposta de criação:

    https://cloud.mongodb.com/api/atlas/v2/unauth/ephemeralClusters/{clusterId}

    A resposta inclui o claimUrl. Para saber mais, consulte Retornar um cluster efêmero do Atlas .

  • Se um agente de codificação de IA tiver criado o cluster, verifique se há um local seguro onde ele possa ter salvo o claimUrl, como o arquivo .env local do seu projeto.

2

Depois de iniciar a sessão, o Atlas exibe a página de reivindicação. Nesta página, faça o seguinte:

  1. Na lista suspensa, selecione uma organização existente ou selecione Create new org for this cluster para criar uma. Quando você solicita o cluster, o Atlas o move para a organização selecionada e cria um projeto para ele lá.

    Importante

    A lista suspensa lista apenas as organizações em que sua conta Atlas tem a função Organization Owner. Quando você solicita o cluster, todos os proprietários da organização na organização selecionada podem gerenciar o cluster e seus dados.

  2. Configurar o acesso IP. Para restringir o acesso, remova 0.0.0.0/0 e permita apenas seu endereço IP atual (recomendado). Para permitir conexões de qualquer endereço IP, mantenha 0.0.0.0/0. Você pode restringir o acesso IP posteriormente nas configurações Network Access do projeto.

  3. Clique em Claim Cluster. Esta é uma ação única que você não pode desfazer.

3

Depois de solicitar o cluster, o Atlas exibe uma página de confirmação com os nomes da organização e do projeto , os detalhes do cluster e a configuração de acesso IP escolhida.

Clique em Go To Project Overview para visualizar o cluster reivindicação na UI do Atlas .

4

Você pode reconfigurar o cluster solicitado e seu projeto usando a UI do Atlas , o Atlas CLI ou a API de administração do Atlas . No nível do cluster, você pode dimensionar o cluster para um nível mais alto para aumentar o armazenamento. No nível do projeto , você pode gerenciar usuários do banco de dados e restringir o acesso IP para aumentar a segurança. Para mais informações, consulte Gerenciar Clusters.

Use os seguintes endpoints da API de administração do Atlas para criar um cluster efêmero e recuperar seu status, conexão e detalhes de reivindicação. Para saber mais, consulte Criar um cluster efêmero do Atlas e Retornar um cluster efêmero do Atlas na especificação da API de administração do Atlas .

Observação

Você pode criar um cluster efêmero somente por meio da API de administração do Atlas , não por meio do Atlas CLI, doHashiCorp Terraform MongoDB Atlas Provider ou de qualquer outra interface.

Cria um cluster efêmero e retorna sua conexão e detalhes de reivindicação.

Método: POST

Ponto de extremidade: https://cloud.mongodb.com/api/atlas/v2/unauth/ephemeralClusters:create

Parâmetros de caminho: nenhum.

Parâmetros de consulta: Nenhum.

Cabeçalhos da solicitação:

Cabeçalho
Obrigatório
Valor

Accept

Sim

application/vnd.atlas.preview+json

Content-Type

Somente com um corpo da solicitação

application/json

Corpo da solicitação:

O corpo da solicitação é opcional. Se você enviar um corpo, inclua o seguinte campo:

Campo
Tipo
Obrigatório
Descrição

clusterName

string

No

Etiqueta legível para humanos que identifica o cluster efêmero. O padrão é Cluster0. Deve corresponder ao padrão ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

Pedido Exemplo :

Exemplo de solicitação de criação
curl -sS -X POST 'https://cloud.mongodb.com/api/atlas/v2/unauth/ephemeralClusters:create' \
-H 'Accept: application/vnd.atlas.preview+json' \
-H 'Content-Type: application/json' \
-d '{ "clusterName": "my-ephemeral-cluster" }'

Código de status de sucesso: 201 Created

Campos de resposta de sucesso:

Retorna os detalhes do novo cluster nos seguintes campos:

Campo
Tipo
Descrição

claimUrl

string (URI)

URL exclusivo para reivindicação deste cluster efêmero. Redireciona para a página de login ou registro do Atlas , onde um usuário entra ou cria uma conta para solicitar o cluster. Válido por 7 dias após a criação do cluster.

clusterId

string

Identificador único do cluster Efêmero. Use esse ID para recuperar o status e os detalhes do cluster em uma solicitação GET.

connectionString

string

Connection string que usa o protocolo mongodb+srv:// para se conectar ao cluster efêmero. Essa string inclui as credenciais SCRAM não editadas (nome de usuário e senha) para um usuário de banco de dados gerado automaticamente ao qual o Atlas concede a função readWriteAnyDatabase incorporada.

expiresAt

string (ISO 8601, UTC)

Data e hora em que o cluster será pausado e não estará mais acessível até que seja reivindicação. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

status

string (enumeração)

Status do cluster efêmero. Um entre PROVISIONING, ACTIVE ou PAUSED.

termsOfService

string

Observe que, ao usar essa API, você concorda com os Termos de Serviço e a Política de Privacidade da Nuvem do MongoDB. Inclui um link para os termos completos.

Cabeçalhos de resposta:

Cabeçalho
Retornado com
Descrição

RateLimit-Limit

201, 429

O número máximo de solicitações que um usuário pode fazer dentro de uma janela de tempo específica.

RateLimit-Remaining

201, 429

O número de solicitações restantes na janela do limite de taxa atual antes que o limite seja atingido.

Retry-After

429

O tempo mínimo que você deve esperar, em segundos, antes de tentar novamente a solicitação de API.

Códigos de status de erro:

Observação

Se você receber um erro 429, o limite compartilhado para a criação de clusters efêmeros foi atingido. Em vez disso, você pode implantar um cluster Gratuito padrão, que fornece a mesma camada do cluster sem uma data de expiração. Para saber como criar e se conectar a um cluster gratuito por meio do Atlas CLI, consulte Introdução.

Status
Descrição

400

Solicitação inválida.

429

Muitas solicitações.

500

Erro interno do servidor.

Retorna os detalhes de um cluster efêmero.

Método: GET

Ponto de extremidade: https://cloud.mongodb.com/api/atlas/v2/unauth/ephemeralClusters/{clusterId}

Parâmetros de caminho:

Parâmetro
Tipo
Obrigatório
Descrição

clusterId

string

Sim

ID exclusivo do cluster efêmero a ser pesquisado.

Parâmetros de consulta: Nenhum.

Cabeçalhos da solicitação:

Cabeçalho
Obrigatório
Valor

Accept

Sim

application/vnd.atlas.preview+json

Corpo da solicitação: nenhum.

Pedido Exemplo :

Exemplo de solicitação de obtenção
curl -sS -X GET 'https://cloud.mongodb.com/api/atlas/v2/unauth/ephemeralClusters/{clusterId}' \
-H 'Accept: application/vnd.atlas.preview+json'

Código de status de sucesso: 200 OK

Campos de resposta de sucesso:

Retorna o status atual e detalhes do cluster nos seguintes campos:

Campo
Tipo
Descrição

claimUrl

string (URI)

URL exclusivo para reivindicação deste cluster efêmero. Redireciona para a página de login ou registro do Atlas , onde um usuário entra ou cria uma conta para solicitar o cluster. Válido por 7 dias após a criação do cluster.

clusterId

string

Identificador único do cluster Efêmero. Use esse ID para recuperar o status e os detalhes do cluster em uma solicitação GET.

connectionString

string

Connection string que usa o protocolo mongodb+srv:// para se conectar ao cluster efêmero. Essa string inclui o nome de usuário SCRAM de um usuário de banco de dados gerado automaticamente, mas substitui a senha por um espaço reservado. O Atlas retorna a senha somente na resposta de criação.

expiresAt

string (ISO 8601, UTC)

Data e hora em que o cluster será pausado e não estará mais acessível até que seja reivindicação. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

status

string (enumeração)

Status do cluster efêmero. Um entre PROVISIONING, ACTIVE ou PAUSED.

termsOfService

string

Observe que, ao usar essa API, você concorda com os Termos de Serviço e a Política de Privacidade da Nuvem do MongoDB. Inclui um link para os termos completos.

Cabeçalhos de resposta:

Cabeçalho
Retornado com
Descrição

RateLimit-Limit

200, 429

O número máximo de solicitações que um usuário pode fazer dentro de uma janela de tempo específica.

RateLimit-Remaining

200, 429

O número de solicitações restantes na janela do limite de taxa atual antes que o limite seja atingido.

Retry-After

429

O tempo mínimo que você deve esperar, em segundos, antes de tentar novamente a solicitação de API.

Códigos de status de erro:

Status
Descrição

400

Solicitação inválida.

404

Não encontrado.

429

Muitas solicitações.

500

Erro interno do servidor.