AAPI MongoDB Atlas for Government funciona da mesma forma que a API Atlas, exceto pelo fato de que ela usa a seguinte URL base:
https://cloud.mongodbgov.com/api/atlas/v2
Para usar a MongoDB Atlas do governo API para gerenciar seus clusters, você deve autenticar suas solicitações de API. A API do MongoDB Atlas para o governo API aceita os seguintes métodos de autenticação:
Tokens de acesso à conta de serviço (OAuth 2.0)
Chaves de API (autenticação Digest HTTP)
Exemplo de uso
Este exemplo do curl recupera usuários de banco de dados para um projeto. Selecione a aba apropriada para o método de autenticação de sua preferência:
Para fazer uma solicitação de API usando uma conta de serviço, use a conta de serviço para gerar um token de acesso e, em seguida, use o token de acesso em sua solicitação:
Recupere o segredo do cliente para sua conta de serviço.
Localize o segredo do cliente que começa com mdb_sa_sk_ que você salvou imediatamente após criar a conta de serviço. Se você não salvou o segredo do cliente , deverá gerar um novo segredo do cliente .
Solicitar um token de acesso.
Importante
O token de acesso é válido por 1 hora (3600 segundos). Você não pode atualizar um token de acesso. Quando esse token de acesso expirar, repita essa etapa para gerar um novo.
Substitua {BASE64-AUTH} no exemplo a seguir pela saída da etapa anterior e execute:
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 {BASE64-AUTH}' \ 6 --header 'content-type: application/x-www-form-urlencoded' \ 7 --data 'grant_type=client_credentials'
{"access_token":"eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImYyZjE2YmE4LTkwYjUtNDRlZS1iMWYwLTRkNWE2OTllYzVhNyJ9.eyJpc3MiOiJodHRwczovL2Nsb3VkLWRldi5tb25nb2RiLmNvbSIsImF1ZCI6ImFwaTovL2FkbWluIiwic3ViIjoibWRiX3NhX2lkXzY2MjgxYmM2MDNhNzFhNDMwYjkwNmVmNyIsImNpZCI6Im1kYl9zYV9pZF82NjI4MWJjNjAzYTcxYTQzMGI5MDZlZjciLCJhY3RvcklkIjoibWRiX3NhX2lkXzY2MjgxYmM2MDNhNzFhNDMwYjkwNmVmNyIsImlhdCI6MTcxMzkwNTM1OSwiZXhwIjoxNzEzOTA4OTU5LCJqdGkiOiI4ZTg1MTM3YS0wZGU1LTQ0N2YtYTA0OS1hMmVmNTIwZGJhNTIifQ.AZSFvhcjwVcJYmvW6E_K5UnDmeiX2sJgL27vo5ElzeBuPawRciKkn6ervZ6IpUTx2HHllGgAAMmhaP9B66NywhfjAXC697X9KcOzm81DTtvDjLrFeRSc_3vFmeGvfUKKXljEdWBnbmwCwtBlO5SJuBxb1V5swAl-Sbq9Ymo4NbyepSnF","expires_in":3600,"token_type":"Bearer"}%
Faça uma chamada de API.
Substitua {ACCESS-TOKEN} no exemplo a seguir pela saída da etapa anterior.
A seguinte amostra de solicitação GET retorna todos os projetos na sua organização:
curl --request GET \ --url https://cloudgov.mongodb.com/api/atlas/v2/groups \ --header 'Authorization: Bearer {ACCESS-TOKEN}' \ --header 'Accept: application/vnd.atlas.2023-02-01+json' \ --header 'Content-Type: application/json'
A seguinte amostra de solicitação POST recebe um corpo da solicitação e cria um projeto denominado MyProject na sua organização:
curl --header 'Authorization: Bearer {ACCESS-TOKEN}' \ --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" }'
Para fazer uma solicitação de API usando as chaves de API, substitua {PUBLIC-KEY}:{PRIVATE-KEY} pelas chaves de API e execute:
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --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/{PROJECT-ID}/databaseUsers?pretty=true"
Você pode encontrar seu
PROJECT-IDem seu Project Settings.Você pode gerar um par de chaves de API no Access Manager da sua organização, na aba API Keys .
Veja a documentação do Atlas
Para saber mais sobre como usar a API, consulte a API do Atlas.
Para saber mais sobre como realizar a autenticação na API com contas de serviço ou chaves de API, consulte Métodos de autenticação da Administration API do Atlas.
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"
Dica
Documentação do Atlas
Para obter informações detalhadas sobre como criar um projeto com a API, incluindo uma solicitação de exemplo , consulte Criar um projeto.
Atlas pelas considerações governamentais
Os seguintes fornecedores de nuvem, produtos MongoDB e funcionalidades não estão disponíveis para todos os recursos de API :
Azure
Atlas Online Archives
Atlas Triggers
MongoDB Charts
Atlas Device SDKs
Clusters gratuitos, flexíveis e
M10
Muitos dos recursos comerciais da API do Atlas são limitados ou indisponíveis:
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, consulteAlertas 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.
Datadog
Quando integrado ao Datadog, o AtlasGov usa o site Datadog for Government (US1-FED).
Para saber mais sobre US1-FED, consulte a documentação DataDog.
backups em nuvem
Restaurações entre projetos padrão e projetos somente da região Gov não são permitidos. Se um backup for criado a partir de um cluster em um projeto somente de região Gov (Amazon Web Services GovCloud ou GCP Assured Workloads), os dados só poderão ser restaurados em um cluster 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ê só pode emparelhar regiões GovCloud do Amazon Web Services com clusters MongoDB em regiões GovCloud do Amazon Web Services. Só é possível emparelhar regiões comerciais da Amazon Web Services com clusters do MongoDB em regiões comerciais da Amazon Web Services.
Só é possível emparelhar regiões de Volumes de trabalho garantidos do GCP com clusters MongoDB em regiões de Volumes de trabalho garantidos do GCP.
Endpoints privados
Você só pode vincular regiões do Amazon Web Services GovCloud a clusters do MongoDB em regiões do Amazon Web Services GovCloud. Você só pode vincular regiões comerciais do Amazon Web Services a clusters do MongoDB em regiões comerciais do Amazon Web Services.
Só é possível vincular regiões de Volumes de trabalho garantidos do GCP a clusters MongoDB 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.