Instala un archivo de clave de licencia firmada en una instalación de Ops Manager para añadir cobertura después de generar una clave de licencia en el Portal de Claves. Si Ops Manager acepta la clave de licencia, recalcula el estado de la clave de licencia y la devuelve, y registra un evento de auditoría License installed .
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 de PUT con el contenido del archivo clave de licencia como cuerpo.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PUT /admin/licensesPará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
Envía el contenido del archivo de clave de licencia como cuerpo de la solicitud. Configura la cabecera de Content-Type a application/json. El endpoint no utiliza parámetros de cuerpo nombrados.
Respuesta
Si Ops Manager acepta la clave de licencia, la respuesta contiene el estado de la clave de licencia recalculado. La respuesta contiene los siguientes campos:
Campo | Tipo | Descripción |
|---|---|---|
| Objeto | Estado agregado de la clave de licencia de la instalación de Ops Manager. Este campo está |
| string | Estado de la clave de licencia de la instalación. Ops Manager devuelve uno de |
| string | Identifica qué produjo el valor |
| booleano | Indica si el estado está |
| Objeto | Siguiente cambio programado en el estado de la clave de licencia. Este campo se |
| string | Evaluador que impulse el siguiente cambio. |
| string | Fecha y hora en que termina el estado actual. |
| string | Estado que sigue al estado actual. |
| Arreglo de objetos | Advertencias abiertas. Ops Manager abre una advertencia de renovación antes de la fecha de finalización de tu pedido. Para saber más, consulta Resumen de las Claves de Licencia de Ops Manager. |
| string | El evaluador que levantó la advertencia. |
| string | Fecha y hora en que se abrió la advertencia. |
| Arreglo de objetos | Temas que cubre la advertencia. Cada objeto contiene una fecha |
| Arreglo de objetos | La contribución de cada evaluador al valor |
| string | El evaluador que emitió el veredicto. |
| string | Indica que el evaluador calculó. |
| string | La fecha y hora en que el incumplimiento entra en vigor, como la fecha de finalización de la orden. Esta fecha es en el futuro mientras el estado está |
| string | Fecha y hora en que se abre la ventana de advertencia de renovación. Este campo es |
| Objeto | Detalles específicos del evaluador. Este campo es |
| Objeto | Siguiente cambio al estado del veredicto. El objeto contiene campos |
| Arreglo de objetos | Claves de licencia que están instaladas en la instalación de Ops Manager. |
| string | Identificador único de la clave de licencia. Utiliza este valor para liberar la clave de licencia. La interfaz del Administrador de Operaciones muestra este valor como el ID de la clave de licencia. |
| booleano | Indica si el Gestor de Operaciones puede usar la clave de licencia para la cobertura. |
| string | Fecha y hora en que MongoDB generó la clave de licencia. |
| string | Fecha y hora en que se instaló la clave de licencia. |
| string | Estado de la clave de licencia. Ops Manager devuelve uno de |
| string | Código de razón para una clave de licencia |
| string | Frase que describe por qué la clave de licencia es |
| string | Fecha y hora en que termina la cobertura de la clave de licencia. Este campo se |
| Arreglo de objetos | Concede que la clave de licencia contiene. Para una clave de licencia |
| string | Tipo de subvención, como |
| string | Identificador de la subvención. Este campo se |
| string | Fecha y hora en que empieza la subvención. |
| string | Fecha y hora en que finaliza la subvención. |
| Arreglo de objetos | Derechos que conlleva la subvención. Cada objeto utiliza los campos descritos para |
| Objeto | Derechos que están activos ahora, agrupados por tipo de derecho. Cada clave es un tipo de derecho, como |
| string | Tipo de derecho a favor. |
| string | Nombre del producto al que se aplica el derecho. Este campo se |
| booleano | Indica si el derecho está en vigor. |
| Objeto | Ventana de validez del derecho a la aplicación. El objeto contiene |
Errors
Si Ops Manager rechaza la clave de licencia, la respuesta tiene el estado HTTP de la siguiente tabla. El campo errorCode del cuerpo de la respuesta contiene el código de error, y el campo detail contiene el mensaje.
Los mensajes utilizan la palabra artifact para referirse a una clave de licencia.
Código de error | HTTP Status | Mensaje |
|---|---|---|
| 400 | Este archivo no pudo leerse. Puede estar corrupto o haber sido modificado tras la firma. Contacta con tu equipo de cuenta de MongoDB para obtener un reemplazo. |
| 400 | Este archivo no puede ser verificado; puede que haya sido modificado tras la firma. Contacta con tu equipo de cuenta de MongoDB para obtener un reemplazo. |
| 400 | Este archivo estaba firmado para una versión diferente de Ops Manager o por una clave no confiable. Contacta con tu equipo de cuenta MongoDB para obtener un archivo compatible. |
| 400 | El certificado de firma de este archivo no es válido para este Gestor de Operaciones. Contacta con tu equipo de cuenta de MongoDB para obtener un reemplazo. |
| 403 | Este artefacto está vinculado a instancias específicas del Administrador de Operaciones y no puede instalarse en esta. Contacta con tu equipo de cuenta de MongoDB. |
| 409 | Este artefacto no es más reciente que uno ya instalado en este Administrador de Operaciones. Instala el último artefacto emitido por tu equipo de cuentas de MongoDB. |
Solicitud de ejemplo
Usa curl para enviar una petición PUT al endpoint /admin/licenses :
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/admin/licenses?pretty=true" \ --data @{LICENSE-KEY-FILE}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:
{ "enforcement": { "effectiveState": "LICENSED", "cause": "term:LICENSED", "enforced": false, "transition": { "evaluatorId": "term", "inStateUntil": "2027-06-30T00:00:00Z", "nextState": "GRACE" }, "warnings": [], "verdicts": [ { "evaluatorId": "term", "state": "LICENSED", "breachAt": "2027-06-30T00:00:00Z", "warningStart": "2027-02-28T00:00:00Z", "metadata": null, "transition": { "inStateUntil": "2027-06-30T00:00:00Z", "nextState": "GRACE" } } ] }, "licenses": [ { "artifactId": "{ARTIFACT-ID}", "usable": true, "generatedAt": "2026-10-01T12:00:00Z", "installedAt": "2026-11-04T15:30:00Z", "status": "ACTIVE", "statusCause": null, "statusReason": null, "termEnd": "2027-06-30T00:00:00Z", "grants": [ { "grantType": "contract", "grantId": "{GRANT-ID}", "startDate": "2026-07-01T00:00:00Z", "endDate": "2027-06-30T00:00:00Z", "entitlements": [] } ] } ], "activeEntitlements": {}}Ejemplo de respuesta a error
El siguiente ejemplo muestra el cuerpo de respuesta cuando Ops Manager rechaza la clave de licencia:
{ "error": 409, "reason": "Conflict", "detail": "This artifact is not newer than one already installed on this Ops Manager. Install the latest artifact issued by your MongoDB account team.", "errorCode": "ARTIFACT_OUTDATED", "parameters": []}