Nota
Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.
Importante
Las copias de seguridad de las bases de datos de MongoDB utilizan el configuración de cifrado de la implementación.
Uso el PUT MétodoHTTP con el siguiente punto final para rotar la clave maestra de KMIP. Emita una PUT solicitud para cada fragmento y otra PUT para el conjunto 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 la ruta de solicitud
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| string | Requerido | Identificador único del proyecto al que pertenece la llave de cifrado. |
| string | Requerido | Identificador único del clúster al que pertenecen las claves de cifrado. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato. |
| ||||||
envolvente | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionarlo, configure envelope=true en la consulta. Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único del proyecto al que pertenece la llave de cifrado. |
| string | Identificador único del clúster al que pertenecen las claves de cifrado. |
| string | Identificador único de la clave maestra de KMIP. Esta clave cifra y restaura las bases de datos principales para una copia de seguridad cifrada. FCV Para obtener más información sobre el cifrado de respaldo para FCV 4.2 o posterior, consulte Instantáneas de respaldo cifradas. |
Ejemplo de solicitud
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"
Ejemplo de respuesta
Encabezado de respuesta
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
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}
Cuerpo de respuesta
Este endpoint devuelve un objeto JSON vacío.