Actualiza la configuración para el cifrado en reposo utilizando las claves que gestionas a través de tu proveedor de nube. MongoDB Cloud cifra todo el almacenamiento, aunque no utilices tu propia gestión de claves. Este recurso requiere que la Cuenta de Servicio solicitante o la Clave API tenga el rol de Propietario del Proyecto. Esta funcionalidad no está disponible para M0 clústeres gratuitos, M2, M5, o clústeres sin servidor.
Después de configurar al menos un cifrado en reposo utilizando un proveedor de Gestión de claves de cliente para el Proyecto MongoDB Cloud, los Propietarios del Proyecto pueden habilitar el cifrado en reposo mediante la Gestión de claves de cliente para cada clúster de MongoDB Cloud que requiera cifrado. El proveedor de cifrado en reposo mediante la gestión de clave de cliente no tiene por qué coincidir con el proveedor de servicios en la nube del clúster. MongoDB Cloud no rota automáticamente las claves de cifrado gestionadas por el usuario. Consulta la documentación y orientación de tu proveedor preferido de cifrado en reposo mediante gestión de claves de clientes para mejores prácticas sobre la rotación de claves. MongoDB Cloud crea automáticamente una alerta de rotación de claves de 90 días cuando configuras el cifrado en reposo usando la Administración de claves de cliente con tu gestión de claves en un Proyecto de MongoDB Cloud. MongoDB nube cifra todo el almacenamiento, lo utilices o no tu propia gestión de claves.
Parámetros de path
-
string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de query
-
Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.Impresión bonita
Cuerpo
Requerido
Los parámetros requeridos dependen de si alguien ha habilitado el cifrado en reposo utilizando la gestión de claves del cliente:
Si has activado el Cifrado en reposo utilizando la Gestión de Claves del Cliente (llave maestra de cliente), Atlas requiere todos los parámetros para el proveedor de cifrado deseado.
- Para utilizar el Key Management Service (KMS) de AWS, MongoDB nube requiere todos los campos en el objeto
awsKms. - Para usar Azure Key Vault, MongoDB Cloud requiere todos los campos en el objeto
azureKeyVault. - Para utilizar Google Cloud Key Management Service (KMS), MongoDB Cloud requiere todos los campos en el objeto
googleCloudKms. Para la autenticación, debe proporcionarserviceAccountKey(credenciales estáticas) oroleId(autenticación basada en cuenta de servicio). Una vez que se configureroleId, ya no se admitiráserviceAccountKey.
Si habilitaste el cifrado en reposo utilizando la gestión de claves del cliente, los administradores solo pueden transferir los campos cambiados del objeto awsKms, azureKeyVault o googleCloudKms para actualizar la configuración a este endpoint.
-
Detalles de configuración de KMS de Amazon Web Services (AWS) y configuración de cifrado en reposo establecida para el proyecto especificado.
Administración de claves de Amazon Web Services... -
Detalles que definen la configuración del cifrado en reposo usando Azure Key Vault (AKV).
Azure Key Vault -
Indicador que señala si el cifrado en reposo para nodos de búsqueda dedicados está habilitado en el proyecto especificado.
-
Detalles que definen la configuración del cifrado en reposo utilizando el Google Cloud Key Management Service (KMS).
Administración de claves de Google Cloud...
curl \
--request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/encryptionAtRest' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"awsKms":{"accessKeyID":"019dd98d94b4bb778e7552e4","customerMasterKeyID":"string","enabled":true,"region":"US_GOV_WEST_1","requirePrivateNetworking":true,"roleId":"32b6e34b3d91647abb20e7b8","secretAccessKey":"string"},"azureKeyVault":{"azureEnvironment":"AZURE","clientID":"string","enabled":true,"keyIdentifier":"https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86","keyVaultName":"string","requirePrivateNetworking":true,"resourceGroupName":"string","roleId":"32b6e34b3d91647abb20e7b8","secret":"string","subscriptionID":"string","tenantID":"string"},"enabledForSearchNodes":true,"googleCloudKms":{"enabled":true,"keyVersionResourceID":"projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1","roleId":"32b6e34b3d91647abb20e7b8","serviceAccountKey":"string"}}'{
"awsKms": {
"accessKeyID": "019dd98d94b4bb778e7552e4",
"customerMasterKeyID": "string",
"enabled": true,
"region": "US_GOV_WEST_1",
"requirePrivateNetworking": true,
"roleId": "32b6e34b3d91647abb20e7b8",
"secretAccessKey": "string"
},
"azureKeyVault": {
"azureEnvironment": "AZURE",
"clientID": "string",
"enabled": true,
"keyIdentifier": "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86",
"keyVaultName": "string",
"requirePrivateNetworking": true,
"resourceGroupName": "string",
"roleId": "32b6e34b3d91647abb20e7b8",
"secret": "string",
"subscriptionID": "string",
"tenantID": "string"
},
"enabledForSearchNodes": true,
"googleCloudKms": {
"enabled": true,
"keyVersionResourceID": "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1",
"roleId": "32b6e34b3d91647abb20e7b8",
"serviceAccountKey": "string"
}
}{
"awsKms": {
"accessKeyID": "019dd98d94b4bb778e7552e4",
"customerMasterKeyID": "string",
"enabled": true,
"region": "US_GOV_WEST_1",
"requirePrivateNetworking": true,
"valid": true
},
"azureKeyVault": {
"azureEnvironment": "AZURE",
"clientID": "string",
"enabled": true,
"keyIdentifier": "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86",
"keyVaultName": "string",
"requirePrivateNetworking": true,
"resourceGroupName": "string",
"roleId": "32b6e34b3d91647abb20e7b8",
"subscriptionID": "string",
"tenantID": "string",
"valid": true
},
"enabledForSearchNodes": true,
"googleCloudKms": {
"enabled": true,
"keyVersionResourceID": "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1",
"roleId": "32b6e34b3d91647abb20e7b8",
"valid": true
}
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}