Recupera el ID de la clave maestra KMIP

Nota

Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, el ID del grupo se mantiene igual. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El endpoint permanece tal como se indica en el documento.

Importante

Las copias de seguridad de las bases de datos MongoDB usan el ajuste de cifrado de la implementación.

Utiliza el método de HTTP GET con el mismo endpoint para recuperar el ID de la clave maestra KMIP actual.

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

Resource

GET /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 especifica si el cuerpo de la respuesta está en formato legible.	`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: `status`: Código de respuesta HTTP `content`: 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. Ops Manager utiliza cursores de copia de seguridad y ya no usa bases de datos principales. Para obtener más información, consulte el Servicio de demonio de copia de seguridad. Para obtener más información sobre el cifrado de copias de seguridad, consulte Instantáneas de copias de seguridad cifradas.

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 200 OK
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

{
  "clusterId" : "{CLUSTER-ID}",
  "groupId" : "{PROJECT-ID}",
  "encryptionKeyUUID": "1234-3456-4567-abcd-def0"
}

Volver

Copia de seguridad de llaves de cifrado

Rotar el ID de la clave maestra KMIP