Tu instalación de Ops Manager genera una clave de identidad: un par de claves que la instalación utiliza para demostrar su identidad cuando se conecta a MongoDB. Si alguien fuera de tu organización obtiene la clave privada, la clave se ve comprometida y podrían hacerse pasar por tu instalación.
Utiliza este extremo para rotar la clave identidad. Rotar reemplaza la clave por un nuevo par de llaves. Si la rotación falla, Ops Manager no aplica ningún cambio y la clave actual permanece activa. La respuesta siempre contiene el resultado de la rotación.
Importante
Tu instalación de Ops Manager debe poder conectarse a MongoDB para rotar la clave. Si no puede, el endpoint devuelve el estado HTTP 502 con el resultado UNREACHABLE o EA_UNAVAILABLE.
Roles necesarios
Para acceder a este recurso, tu clave API debe tener el rolGlobal Owner. El rol de Propietario Global es el rol más alto en Ops Manager. Solo los usuarios con este rol pueden ver y gestionar las claves de licencia.
Solicitud
Envía una solicitud POST para iniciar la rotación.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /admin/artifacts/identity/rotateParámetros de ruta de solicitud
Este endpoint no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de Solicitud Query
Este punto final acepta los siguientes parámetros de consulta:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
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:
|
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
La respuesta contiene los siguientes campos:
Campo | Tipo | Descripción |
|---|---|---|
| string | Resultado de la rotación. Ops Manager devuelve uno de los valores en la siguiente tabla. |
| string | Frase que describe por qué el Jefe de Operaciones no aplicó la rotación. Este campo es |
La siguiente tabla lista cada resultado con su estado HTTP y mensaje:
Resultado | HTTP Status | Mensaje |
|---|---|---|
| 200 | El Jefe de Operaciones no responde ningún mensaje. |
| 502 | No se pudo contactar con MongoDB para completar la rotación. No se aplicó ningún cambio: la clave actual permanece activa. Inténtalo de nuevo en breve. |
| 502 | El servicio avanzado de MongoDB Enterprise no está disponible. No se ha aplicado ningún cambio: la clave actual permanece activa. Inténtalo de nuevo en breve. |
| 409 | Aún no hay una identidad de inscripción que rotar — se crea una en la primera instalación. |
| 409 | MongoDB rechazó la prueba de posesión de la rotación. La clave actual sigue activa. Contacta con tu equipo de cuenta de MongoDB. |
| 409 | La identidad de inscripción cambió simultáneamente. No se aplicó ningún cambio — vuelve a intentarlo pronto. |
| 409 | MongoDB rechazó la solicitud de rotación. La clave actual sigue activa. |
Solicitud de ejemplo
Usa curl para enviar una petición POST al endpoint /admin/artifacts/identity/rotate :
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/artifacts/identity/rotate?pretty=true"Respuesta de ejemplo
Los siguientes ejemplos muestran los encabezados de respuesta y el cuerpo de respuesta de una solicitud exitosa.
Encabezado de respuesta
Los siguientes encabezados muestran una respuesta no autorizada y una respuesta exitosa:
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
El siguiente ejemplo muestra el cuerpo de respuesta:
{ "outcome": "ROTATED", "message": null}