Acesso programático AtlasGov

Ferramentas de DevOps

O AtlasGov é compatível com as seguintes ferramentas DevOps:

Exemplo de uso

Este exemplo do curl recupera usuários do banco de dados para um projeto. Selecione a aba apropriada para o método de autenticação de sua preferência:

echo -n {clientId}:{clientSecret} | base64

1
curl --request POST \
2
   --url https://cloud.mongodbgov.com/api/oauth/token \
3
   --header 'accept: application/json' \
4
   --header 'cache-control: no-cache' \
5
   --header 'authorization: Basic {base64Auth}' \
6
   --header 'content-type: application/x-www-form-urlencoded' \
7
   --data 'grant_type=client_credentials'

{"access_token":"{accessToken}","expires_in":3600,"token_type":"Bearer"}%

curl --request GET \
   --url https://cloudgov.mongodb.com/api/atlas/v2/groups \
   --header 'Authorization: Bearer {accessToken}' \
   --header 'Accept: application/vnd.atlas.2023-02-01+json' \
   --header 'Content-Type: application/json'

curl --header 'Authorization: Bearer {accessToken}' \
   --header "Content-Type: application/json" \
   --header "Accept: application/vnd.atlas.2023-02-01+json" \
   --include \
   --request POST "https://cloudgov.mongodb.com/api/atlas/v2/groups" \
   --data '
      {
         "name": "MyProject",
         "orgId": "5a0a1e7e0f2912c554080adc"
      }'

curl --user "{publicKey}:{privateKey}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \ # update date to desired API version
  --include \
  --request GET "https://cloud.mongodbgov.com/api/atlas/v2/groups/{projectId}/databaseUsers?pretty=true"

Veja a documentação do Atlas

• Para saber mais sobre como usar a API, consulte a API do Atlas .

• Para aprender mais sobre como autenticar na API com contas de serviço ou chaves de API, consulte Métodos de autenticação da Atlas Administration API.

• Para configurar a API, consulte Configurar o acesso à API Atlas.

• Para obter uma lista de possíveis erros, consulte Códigos de erro da API do Atlas.

Criando um projeto

Você deve designar projetos para uso padrão ou governamental (gov) da região após a criação. Você não pode implantar clusters entre regiões governamentais e padrão no mesmo projeto.

Por padrão, a API do AtlasGov designa novos projetos para uso padrão da região.

Para usar a API para criar um projeto para regiões governamentais, inclua o seguinte em seus dados de solicitação do POST :

"regionUsageRestrictions" : "GOV_REGIONS_ONLY"

Utilizadores de banco de dados

Os usuários do banco de dados que se autenticam com SCRAM devem usar SCRAM-SHA-256.

Clusters

Os clusters do AtlasGov devem ser de nível M20 ou superior. O Atlas não suporta clusters Free e Flex.

Alertas

• Os alertas relacionados às formas de pagamento não estão disponíveis.

• Os alertas podem vir de vários endereços de e-mail diferentes. Para obter mais informações, consulte alerta e comunicações.

Configurações de integração de terceiros

Você deve ter a função Project Owner para configurar uma integração de monitoramento de terceiros.

backups em nuvem

Restaurações entre projetos padrão e projetos somente da região Gov não são permitidas. Se você criar um backup de um cluster em um projeto somente de região Gov (AWS GovCloud ou GCP Assured Workloads), poderá restaurar os dados para um cluster somente em um projeto somente de região Gov. A mesma restrição se aplica a projetos padrão, em que backups em regiões padrão só podem ser restaurados em clusters em projetos padrão.

A restauração entre nuvens é suportada entre as regiões Amazon Web Services GovCloud e GCP Assured Workloads.

Snapshots de cluster flexíveis e tarefas de restauração

Os clusters flexíveis não estão disponíveis no AtlasGov.

Arquivo On-line

Os Arquivos Online não estão disponíveis no AtlasGov.

Emparelhamento de rede

• Você pode emparelhar regiões da AWS GovCloud com clusters MongoDB somente em regiões da AWS GovCloud. Você pode realizar o emparelhamento de regiões comerciais da AWS com clusters MongoDB somente em regiões comerciais da AWS.

• Você pode emparelhar regiões de cargas de trabalho garantidas do GCP com clusters MongoDB somente em regiões de cargas de trabalho garantidas do GCP.

Endpoints privados

• Você pode vincular regiões da AWS GovCloud a clusters MongoDB somente em regiões da AWS GovCloud. Você pode vincular regiões comerciais da AWS a clusters do MongoDB somente em regiões comerciais da AWS.

• Você pode vincular regiões de Volumes de trabalho segurados do GCP a clusters MongoDB somente em regiões de Volumes de trabalho garantidos do GCP.

Monitoramento e registros

Além do registro padrão do Atlas, o AtlasGov registra o nome de usuário e o endereço IP associados a todas as tentativas fracassadas de login, bloqueios temporários e autenticações de resumo da API com falha.

Criptografia em repouso usando o gerenciamento de chaves de cliente

• Você deve usar chaves KMS nas regiões do Amazon Web Services GovCloud e GCP Assured Workloads para criptografar dados em projetos somente da região do Amazon Web Services GovCloud e GCP Assured Workloads. Você deve usar chaves KMS em regiões comerciais do Amazon Web Services para criptografar dados em projetos somente de região comercial do Amazon Web Services.

Atlas users

Você não pode criar o MongoDB Atlas para usuários do governo. O MongoDB Atlas for Government está disponível apenas por convite.

Atlas Stream Processing

Atlas Stream Processing não está disponível no AtlasGov.

Acionadores

Os Atlas Triggers não estão disponíveis no AtlasGov.