Introducción al uso programático
MongoDB Atlas for Government admite el acceso programático utilizando los siguientes recursos. Sin embargo, AtlasGov está diseñado con consideraciones adicionales de seguridad, cumplimiento y operativas para satisfacer las necesidades de las organizaciones que gestionan datos sensibles. Para obtener más información sobre cómo estas consideraciones afectan la disponibilidad de funcionalidades, consulte Atlas de Consideraciones para el Gobierno.
Herramientas DevOps
AtlasGov admite las siguientes herramientas DevOps:
Producto | Descripción |
|---|---|
Gestione los recursos de Atlas junto con sus aplicaciones basadas en Kubernetes, a través de su flujo de trabajo existente de Kubernetes. | |
Integra Atlas en tus flujos de trabajo de entrega continua con el proveedor de MongoDB Atlas de HashiCorp Terraform. |
Atlas para gobierno API
El MongoDB Atlas para el Gobierno 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 para gestionar tus clústeres, debes autenticar tus solicitudes de API. La API de MongoDB Atlas for Government acepta los siguientes métodos de autenticación:
Tokens de acceso de cuenta de servicio (OAuth 2.0)
Claves API (Digest access authentication)
Importante
Recomendamos utilizar cuentas de servicio en lugar de API claves para autenticarte en la API del gobierno de MongoDB Atlas. Las claves API son un método de autenticación heredado.
Ejemplo de uso
Esto curl el ejemplo recupera usuarios de base de datos para un Proyecto. Selecciona la pestaña correspondiente a tu método de autenticación preferido:
Para realizar una solicitud API utilizando una cuenta de servicio, se debe usar la cuenta de servicio para generar un token de acceso y luego usar el token de acceso en la 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 {base64Auth} 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 {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"}%
Haz una llamada a la API.
Reemplace {accessToken} 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 {accessToken}' \ --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 {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" }'
Para realizar una solicitud a la API usando claves API, reemplaza {publicKey}:{privateKey} con tus claves API y ejecuta:
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"
Puedes encontrar tu
projectIden tu Project Settings.Puedes generar un par de claves API en el Access Manager de tu organización, en la pestaña API Keys.
Consulta la documentación de Atlas
Para aprender más sobre cómo utilizar la API, consulta el API de Atlas.
Para aprender más sobre cómo autenticarse en la API con cuentas de servicio o llaves de API vea Métodos de autenticación de la API de administración de Atlas.
Para configurar la API, consulte Configure el acceso a la API de Atlas.
Para ver una lista de posibles errores, consulta Códigos de error de la API Atlas.
Crear un proyecto
Debes designar proyectos para el uso en regiones estándar o de gobierno (gov) al momento de la creación. No se pueden implementar clústeres en regiones gubernamentales y estándar en el mismo proyecto.
Por defecto, la API de AtlasGov designa los nuevos proyectos para el uso estándar de la región.
Para utilizar la API para crear un proyecto para regiones gubernamentales, incluye lo siguiente en tus datos de solicitud de POST:
"regionUsageRestrictions" : "GOV_REGIONS_ONLY"
Tip
Documentación de 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 de Consideraciones para el Gobierno
Los siguientes proveedores de la nube, productos de MongoDB y funcionalidades no están disponibles para todos los recursos API:
Azure
Atlas Online Archives
Atlas Triggers
MongoDB Charts
SDK de Dispositivo Atlas
clústeres Free, Flex y
M10
Muchos de los recursos comerciales de la API Atlas API están limitados o no disponibles:
Usuarios de base de datos
Los usuarios de base de datos que se autentican con SCRAM deben utilizar SCRAM-SHA-256.
Clústeres
Los clústeres de AtlasGov deben ser de nivel M20 o superior. Atlas no es compatible con los clústeres Free y Flex.
Alertas
No se encuentran disponibles las alertas relacionadas con los métodos de pago.
Las alertas pueden provenir de varias direcciones de correo electrónico diferentes. Para más información, consulta Alertas y comunicaciones.
Configuración de integración de terceros
Debe tener el rol Project Owner para configurar una integración de supervisión de terceros.
Datadog
Cuando está integrado con Datadog, AtlasGov utiliza el sitio Datadog para Gobierno (US1-FED).
Para aprender 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 gubernamental. Si creas una copia de seguridad desde un clúster en un proyecto solo de región gubernamental (AWS GovCloud o GCP Assured Workloads), puedes restaurar los datos en un clúster solo en un proyecto de región gubernamental. La misma restricción se aplica a los proyectos estándar, donde las copias de seguridad en regiones estándar solo pueden restaurarse en clústeres de proyectos estándar.
La restauración entre nubes se admite entre AWS GovCloud y las regiones de GCP Assured Workloads.
Instantáneas de clúster Flex 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 puedes emparejar regiones AWS GovCloud con clústeres de MongoDB únicamente en regiones AWS GovCloud. Puedes conectar las regiones comerciales de AWS solamente con clústeres de MongoDB que se encuentren en regiones comerciales de AWS.
Solo puedes establecer interconexión entre regiones de cargas de trabajo garantizadas de GCP con clústeres de MongoDB solo en regiones de cargas de trabajo garantizadas de GCP.
Nodos privados
Puedes vincular las regiones de AWS GovCloud con clústeres de MongoDB solo en regiones de AWS GovCloud. Puedes vincular las regiones comerciales de AWS con los clústeres de MongoDB solo en las regiones comerciales de AWS.
Solo puedes vincular regiones de GCP Assured cargas de trabajo con clústeres de MongoDB en regiones de GCP Assured cargas de trabajo.
Supervisión y registros
Además del registro estándar de Atlas, AtlasGov registra el nombre de usuario y la dirección IP asociada a todos los intentos fallidos de inicio de sesión, bloqueos temporales y autenticaciones fallidas de "digest" 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 puedes crear usuarios de MongoDB Atlas para gobierno. MongoDB Atlas for Government está disponible solo por invitación.
Atlas Stream Processing
Atlas Stream Processing no está disponible en AtlasGov.
Activadores
Triggers no están disponibles en AtlasGov.