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.

Criar um cluster efêmero do Atlas

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

Para criar um cluster Ephemeral e obter uma string de conexão pronta para uso em menos de um minuto, envie uma solicitação POST para o seguinte ponto de extremidade:

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

Para o fluxo de trabalho completo, cabeçalhos necessários e 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 reivindicar o cluster, abra o claimUrl da resposta de criação e faça login 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 humano pode reivindicá-lo.

Um cluster Ephemeral é um cluster Atlas Free (M0) com uma vida útil 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, você não pode dimensionar a camada do cluster, adicionar usuários de banco de dados, restringir o acesso IP ou realizar outras operações administrativas.

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

  • Camada do cluster: Gratuita (M0).

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

  • Acesso de 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 pausa 2 dias após a criação e o exclui 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 de 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 total de operações de leitura e gravar por segundo no total.

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

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

Use o fluxo de trabalho a seguir para criar e se conectar a um cluster Ephemeral. Um agente de codificação de IA pode concluir cada etapa deste fluxo de trabalho sem intervenção humana.

1

Envie uma solicitação POST para o seguinte ponto de extremidade:

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

A seguinte solicitação de exemplo cria um cluster Ephemeral chamado 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 ponto de extremidade de criação retorna uma resposta no seguinte formato:

Exemplo de resposta de criação

{ "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 campo:

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

  • clusterId: Identificador exclusivo do cluster efêmero. Para recuperar status, claimUrl e outros detalhes do cluster, envie uma solicitação GET para o seguinte ponto de extremidade, substituindo {clusterId} por este valor:

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

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

  • connectionString: String de conexão que usa o protocolo mongodb+srv:// para se conectar ao cluster Ephemeral. Inclui o nome de usuário e a senha de um usuários de banco de dados gerado automaticamente que pode ler e gravar dados no cluster. Qualquer cliente que use esta string de conexão é autenticado como este usuários 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 reivindicado. Um cluster Ephemeral 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 esta API, você concorda com os Termos de Serviço da Nuvem e a Política de Privacidade do MongoDB. Inclui um link para os termos completos.

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

2

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

Aviso

Trate connectionString, claimUrl e clusterId como segredos. Qualquer pessoa com connectionString pode ler e gravar dados do cluster. Qualquer pessoa com claimUrl pode reivindicar o cluster para sua própria conta Atlas, e qualquer pessoa com clusterId pode recuperar claimUrl do ponto de extremidade get. O Suporte do MongoDB não pode recuperar esses valores ou transferir a propriedade de um cluster reivindicado.

Salve todos os três valores em uma localização segura onde a pessoa que reivindicar o cluster possa recuperá-los. Por exemplo, use um gerente de segredos compartilhado ou um arquivo .env local ignorado pelo git. Não substitua segredos existentes nessa localização.

3

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

  • Código do aplicativo: forneça a string de conexão ao driver do MongoDB para sua linguagem de programação ao inicializar o objeto cliente que se conecta ao cluster. Esta é a escolha típica ao se conectar a partir de um aplicativo. 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 de forma interativa:

    Exemplo de conexão via linha de comando

    mongosh "<connectionString>"

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

Observação

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

4

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

Para reivindicar o cluster, um humano deve fazer login no Atlas em um navegador. Escolha uma das seguintes opções:

  • Reivindique agora: compartilhe o claimUrl apenas com a pessoa que reivindicará o cluster. Eles podem seguir o procedimento em Reivindicar um cluster efêmero para reivindicar o cluster.

  • Reivindicar mais tarde: Salve o claimUrl em uma localização segura que permaneça disponível para a pessoa que reivindicará o cluster. Essa pessoa pode então reivindicar o cluster a qualquer momento dentro de 7 dias após a criação.

  • Nunca reivindicar: Não tome nenhuma ação. O Atlas exclui o cluster 7 dias após a criação.

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

Ao reivindicar um cluster Ephemeral, o Atlas faz as seguintes alterações:

  • Estende 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 reivindicado permanece disponível até que você o exclua ou até que o Atlas o pause devido a 30 dias de inatividade.

  • Preserva os dados e a string de conexão do cluster: O cluster reivindicado mantém todos os seus dados, e a string de conexão da resposta de criação continua funcionando 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 reivindicado em um novo projeto dentro de uma organização nova ou existente de propriedade da conta que reivindica o cluster.

  • Concede acesso total ao cluster: A conta que reivindica o cluster é um Organization Owner da organização do cluster, o que também concede a função Project Owner em todos os projetos dessa organização. Como Project Owner, você tem acesso ao banco de dados para ler e gravar os dados do cluster e acesso administrativo para gerenciar o cluster e seu projeto usando a IU do Atlas, o Atlas CLI ou a Atlas Administration API.

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

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

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

  2. Na página de login, faça login no Atlas com uma conta existente ou crie uma nova conta. Ao reivindicar o cluster na próxima etapa, esta conta obtém acesso administrativo e ao banco de dados do 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 reivindicar o cluster. Ela expira 7 dias após a criação do cluster. Se você perder a URL de reivindicação, recupere-a com um dos seguintes métodos:

  • Envie uma solicitação GET para o seguinte ponto de extremidade, 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 aprender mais, consulte Retornar um cluster efêmero do Atlas.

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

2

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

  1. No menu suspenso, selecione uma organização existente ou selecione Create new org for this cluster para criar uma. Ao reivindicar o cluster, o Atlas o move para a organização selecionada e cria um projeto para ele lá.

    Importante

    A lista suspensa mostra apenas as organizações nas quais sua conta do Atlas tem a função Organization Owner. Ao reivindicar o cluster, cada Organization Owner na organização selecionada pode gerenciar o cluster e seus dados.

  2. Configure 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 de Network Access do projeto.

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

3

Após reivindicar 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 reivindicado na IU do Atlas.

4

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

Para criar um cluster Ephemeral, envie uma solicitação POST conforme descrito abaixo em Criar um cluster Atlas Ephemeral. Para recuperar seu status, conexão e detalhes da reivindicação, envie uma solicitação GET conforme descrito abaixo em Retornar um cluster Atlas Ephemeral.

Para obter a especificação completa da Atlas Administration API, consulte Criar um cluster Atlas efêmero e Retornar um cluster Atlas efêmero.

Observação

Você pode criar um cluster Ephemeral apenas por meio da Atlas Administration API ou da Atlas CLI. HashiCorp Terraform MongoDB Atlas Provedor e todas as outras interfaces não suportam esta operação.

Para encontrar os equivalentes da Atlas CLI dos seguintes pontos de extremidade, consulte a referência do comando atlas api ephemeralClusters.

Cria um cluster efêmero e retorna seus detalhes de conexão e 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 query: Nenhum.

Cabeçalhos de solicitação:

Cabeçalho
Obrigatório
Valor

Accept

Sim

application/vnd.atlas.preview+json

Content-Type

Apenas com um corpo de 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 por humanos que identifica o cluster efêmero. O padrão é Cluster0. Deve corresponder ao padrão ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

Exemplo de solicitação:

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 campo:

Campo
Tipo
Descrição

claimUrl

string (URI)

URL exclusiva para reivindicar este cluster efêmero. Redireciona para a página de login ou registro do Atlas, onde o usuário faz login ou cria uma conta para reivindicar o cluster. Válido por 7 dias após a criação do cluster.

clusterId

string

Identificador exclusivo do cluster efêmero. Use este ID para recuperar o status e os detalhes do cluster em uma solicitação GET.

connectionString

string

String de conexão 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 integrada.

expiresAt

string (ISO 8601, UTC)

Data e hora em que o cluster será pausado e não estará mais acessível até ser reivindicado. 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 esta API, você concorda com os Termos de Serviço da Nuvem e a Política de Privacidade 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 de limite de taxa atual antes que o limite seja atingido.

Retry-After

429

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

Códigos de status de erro:

Observação

Se você receber um erro 429, o limite compartilhado para a criação de cluster 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 aprender a criar e se conectar a um cluster gratuito por meio do Atlas CLI, consulte Comece a usar.

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 Ephemeral a ser pesquisado.

Parâmetros de query: Nenhum.

Cabeçalhos de solicitação:

Cabeçalho
Obrigatório
Valor

Accept

Sim

application/vnd.atlas.preview+json

Corpo da solicitação: Nenhum.

Exemplo de solicitação:

Exemplo de solicitação GET

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 os detalhes do cluster nos seguintes campos:

Campo
Tipo
Descrição

claimUrl

string (URI)

URL exclusiva para reivindicar este cluster efêmero. Redireciona para a página de login ou registro do Atlas, onde o usuário faz login ou cria uma conta para reivindicar o cluster. Válido por 7 dias após a criação do cluster.

clusterId

string

Identificador exclusivo do cluster efêmero. Use este ID para recuperar o status e os detalhes do cluster em uma solicitação GET.

connectionString

string

String de conexão que usa o protocolo mongodb+srv:// para se conectar ao cluster Ephemeral. 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 apenas 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é ser reivindicado. 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 esta API, você concorda com os Termos de Serviço da Nuvem e a Política de Privacidade 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 de limite de taxa atual antes que o limite seja atingido.

Retry-After

429

O tempo mínimo que você deve aguardar, em segundos, antes de tentar novamente a solicitação da 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.