Rotar el ID de clave principal de KMIP

Esta versión de la documentación está archivada y ya no tiene soporte. Ver el documentación actual para aprender cómo actualizar tu versión de MongoDB Ops Manager.

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que tu id. de proyecto. Para los grupos existentes, su ID de grupo/ID del grupo seguirá siendo el mismo. Esta página utiliza el término más familiar grupo al referirse a descripciones. El endpoint se mantiene tal como se indica en el documento.

Importante

Este endpoint funciona con copias de seguridad de bases de datos de MongoDB que ejecutan compatibilidad de características entre versiones 4.0 o anterior. Las copias de seguridad de las bases de datos de MongoDB que ejecutan compatibilidad de características entre versiones 4.2 o posterior utilizan el la configuración de cifrado de la implementación.

Usa el PUT HTTP método con el siguiente endpoint para rotar la clave maestra KMIP . Emitir una solicitud PUT para cada partición y otra solicitud PUT para el set de réplicas del servidor de configuración.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

PUT /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/encryptionKey

Request Parameters

Parámetros de ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
`{GROUP-ID}`	string	Requerido	Identificador único del proyecto al que pertenece la llave de cifrado.
`{CLUSTER-ID}`	string	Requerido	Identificador único del clúster al que pertenecen las llaves de cifrado.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
Estado	Código de respuesta HTTP
envelope	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
`groupId`	string	Identificador único del proyecto al que pertenece la llave de cifrado.
`clusterId`	string	Identificador único del clúster al que pertenecen las llaves de cifrado.
`encryptionKeyUUID`	string	Identificador único de la clave maestra KMIP. Esta clave cifra y restaura las bases de datos principales para una copia de seguridad cifrada. compatibilidad de características entre versiones `4.2` y luego use cursores de copia de seguridad en lugar de bases de datos principales. Para obtener más información, consulte Servicio Daemon de copia de seguridad. Para obtener más información sobre el cifrado de copias de seguridad para FCV 4.2 o posterior, consulta Instantáneas cifradas de copias de seguridad.

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request PUT "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/encryptionKey"

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Respuesta del cuerpo

Este endpoint devuelve un objeto JSON vacío.

Volver

Recupera el ID de clave maestra KMIP

Migración a MongoDB Atlas