El Atlas de MongoDB para el Gobierno La API funciona de la misma manera que la API de Atlas, excepto que utiliza la siguiente URL base:
https://cloud.mongodbgov.com/api/atlas/v2
Para usar la API de MongoDB Atlas para el Gobierno y administrar sus clústeres, debe autenticar sus solicitudes de API. La API de MongoDB Atlas para el Gobierno acepta los siguientes métodos de autenticación:
Tokens de acceso a la cuenta de servicio (OAuth 2.0)
Claves API (Digest access authentication)
Ejemplo de uso
Este curl El ejemplo recupera los usuarios de la base de datos de un proyecto. Seleccione la pestaña correspondiente a su método de autenticación preferido:
Para realizar una solicitud API utilizando una cuenta de servicio, use la cuenta de servicio para generar un token de acceso y luego use el token de acceso en su solicitud:
Se debe recuperar el secreto del cliente para su cuenta de servicio.
Ubique el secreto del cliente que comienza con mdb_sa_sk_ que guardó inmediatamente después de crear la cuenta de servicio. Si no guardaste el secreto de cliente, debes generar un nuevo secreto de cliente.
Se debe solicitar un token de acceso.
Importante
El token de acceso es válido por 1 hora (3600 segundos). No se puede actualizar un token de acceso. Cuando este token de acceso expire, se debe repetir este paso para generar uno nuevo.
Se debe reemplazar {BASE64-AUTH} en el siguiente ejemplo con el resultado del paso anterior, luego se debe ejecutar:
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"}%
Realizar una llamada API.
Reemplace {ACCESS-TOKEN} en el siguiente ejemplo con el resultado del paso anterior.
El siguiente ejemplo de una solicitud GET devuelve todos los proyectos en tu organización:
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'
El siguiente ejemplo de una solicitud POST toma un cuerpo de solicitud y crea un proyecto llamado MyProject en tu organización:
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 realizar una solicitud de API utilizando claves de API, reemplace {PUBLIC-KEY}:{PRIVATE-KEY} con sus claves de API y ejecute:
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"
Puedes encontrar tu
PROJECT-IDen tu Project Settings.Puede generar un par de claves API en el de su Access Manager organización, en la API Keys pestaña.
Ver la documentación del Atlas
Para obtener más información sobre el uso de la API, consulte la API de Atlas.
Para obtener más información sobre cómo autenticarse en la API con cuentas de servicio o claves de API, consulte Métodos de autenticación de la API de administración de Atlas.
Para configurar la API, consulte Configurar el acceso a la API de Atlas.
Para obtener una lista de posibles errores, consulte Códigos de error de la API de Atlas.
Creando un proyecto
Debe designar los proyectos para su uso en la región estándar o gubernamental (gov) al crearlos. No puede implementar clústeres en regiones gubernamentales y estándar en el mismo proyecto.
De forma predeterminada, la API de AtlasGov designa nuevos proyectos para el uso de la región estándar.
Para utilizar la API para crear un proyecto para regiones gubernamentales, incluya lo siguiente en los datos de su solicitud POST:
"regionUsageRestrictions" : "GOV_REGIONS_ONLY"
Tip
Documentación del Atlas
Para obtener información detallada sobre cómo crear un proyecto con la API, incluido un ejemplo de solicitud, consulta Crea un proyecto.
Atlas para consideraciones gubernamentales
Los siguientes proveedores de nube, productos MongoDB y funciones no están disponibles para todos los recursos de API:
Azure
Atlas Online Archives
Atlas Triggers
MongoDB Charts
SDK de dispositivos Atlas
Clústeres gratuitos, flexibles y
M10
Muchos de los recursos comerciales de la API de Atlas son limitados o no están disponibles:
Usuarios de base de datos
Los usuarios de SCRAM-SHA-256 la base de datos que se autentican con SCRAM deben utilizar.
Clústeres
Los clústeres de AtlasGov deben ser de nivel M20 o superior. Atlas no admite clústeres gratuitos ni flexibles.
Alertas
Las alertas relacionadas con los métodos de pago no están disponibles.
Las alertas pueden provenir de varias direcciones de correo electrónico diferentes. Para obtener más información, consulte Alertas y Comunicaciones.
Configuración de integración de terceros
Debe tener el rol para configurar una integración de monitoreo de Project Owner terceros.
Datadog
Cuando se integra con Datadog, AtlasGov utiliza el sitio Datadog para el gobierno (US1-FED).
Para obtener más información sobre US1-FED, consulte la documentación de Datadog.
copias de seguridad en la nube
No se permiten restauraciones entre proyectos estándar y proyectos exclusivos de la región Gov. Si se crea una copia de seguridad desde un clúster en un proyecto exclusivo de la región Gov (AWS GovCloud o GCP Assured Workloads), los datos solo se pueden restaurar en un clúster de dicho proyecto. La misma restricción se aplica a los proyectos estándar, donde las copias de seguridad en regiones estándar solo se pueden restaurar en clústeres de proyectos estándar.
Se admite la restauración entre nubes entre las regiones de AWS GovCloud y GCP Assured Workloads.
Instantáneas de clúster flexible y trabajos de restauración
Los clústeres flexibles no están disponibles en AtlasGov.
Archivo en línea
Los ficheros en linea no están disponibles en AtlasGov.
Emparejamiento de red
Solo se pueden emparejar regiones de AWS GovCloud con clústeres de MongoDB en regiones de AWS GovCloud. Solo se pueden emparejar regiones de AWS Commercial con clústeres de MongoDB en regiones de AWS Commercial.
Solo puede vincular regiones de GCP Assured Workloads con clústeres de MongoDB en regiones de GCP Assured Workloads.
Nodos privados
Solo puedes vincular regiones de AWS GovCloud con clústeres de MongoDB en regiones de AWS GovCloud. Solo puedes vincular regiones comerciales de AWS con clústeres de MongoDB en regiones comerciales de AWS.
Solo puede vincular regiones de GCP Assured Workloads con clústeres de MongoDB en regiones de GCP Assured Workloads.
Monitoreo y registros
Además del registro estándar de Atlas, AtlasGov registra el nombre de usuario y la dirección IP asociados con todos los intentos fallidos de inicio de sesión, bloqueos temporales y autenticaciones fallidas de resumen de API.
Cifrado en reposo utilizando la gestión de claves del cliente
Debes utilizar claves KMS en AWS GovCloud y en las regiones de cargas de trabajo aseguradas de GCP para cifrar datos en proyectos exclusivos de dichas regiones. Debes utilizar claves KMS en las regiones comerciales de AWS para cifrar datos en proyectos exclusivos de las regiones comerciales de AWS.
Usuarios de Atlas
No es posible crear MongoDB Atlas para usuarios gubernamentales. MongoDB Atlas para usuarios gubernamentales solo está disponible por invitación.
Atlas Stream Processing
Atlas Stream Processing no está disponible en AtlasGov.
Activadores
Los activadores no están disponibles en AtlasGov.