Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.

Instala una clave de licencia en Ops Manager

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 .

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.

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/licenses

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

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.

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

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.

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

enforcement

Objeto

Estado agregado de la clave de licencia de la instalación de Ops Manager. Este campo está null hasta que Ops Manager calcula el estado por primera vez.

enforcement.effectiveState

string

Estado de la clave de licencia de la instalación. Ops Manager devuelve uno de LICENSED, GRACE, EXPIREDo UNLICENSED. Para saber cómo los estados se corresponden con la interfaz de Ops Manager, consulta Resumen de las Claves de Licencia de Ops Manager.

enforcement.cause

string

Identifica qué produjo el valor effectiveState .

enforcement.enforced

booleano

Indica si el estado está EXPIRED o UNLICENSED. Ops Manager no restringe ninguna operación en estos estados.

enforcement.transition

Objeto

Siguiente cambio programado en el estado de la clave de licencia. Este campo se null cuando no hay ningún cambio programado.

enforcement.transition.evaluatorId

string

Evaluador que impulse el siguiente cambio.

enforcement.transition.inStateUntil

string

Fecha y hora en que termina el estado actual.

enforcement.transition.nextState

string

Estado que sigue al estado actual.

enforcement.warnings

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.

enforcement.warnings[n].evaluatorId

string

El evaluador que levantó la advertencia.

enforcement.warnings[n].since

string

Fecha y hora en que se abrió la advertencia.

enforcement.warnings[n].subjects

Arreglo de objetos

Temas que cubre la advertencia. Cada objeto contiene una fecha id y una since . Esta matriz está vacía cuando la advertencia se aplica a toda la instalación.

enforcement.verdicts

Arreglo de objetos

La contribución de cada evaluador al valor effectiveState .

enforcement.verdicts[n].evaluatorId

string

El evaluador que emitió el veredicto.

enforcement.verdicts[n].state

string

Indica que el evaluador calculó.

enforcement.verdicts[n].breachAt

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á LICENSED.

enforcement.verdicts[n].warningStart

string

Fecha y hora en que se abre la ventana de advertencia de renovación. Este campo es null a menos que el estado del veredicto sea LICENSED.

enforcement.verdicts[n].metadata

Objeto

Detalles específicos del evaluador. Este campo es null para evaluadores que no proporcionan ninguno.

enforcement.verdicts[n].transition

Objeto

Siguiente cambio al estado del veredicto. El objeto contiene campos inStateUntil y nextState . Este campo se null cuando no hay ningún cambio programado.

licenses

Arreglo de objetos

Claves de licencia que están instaladas en la instalación de Ops Manager.

licenses[n].artifactId

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.

licenses[n].usable

booleano

Indica si el Gestor de Operaciones puede usar la clave de licencia para la cobertura.

licenses[n].generatedAt

string

Fecha y hora en que MongoDB generó la clave de licencia.

licenses[n].installedAt

string

Fecha y hora en que se instaló la clave de licencia.

licenses[n].status

string

Estado de la clave de licencia. Ops Manager devuelve uno de ACTIVE, EXPIRED, RELEASEDo DENIED. Una clave de licencia se ACTIVE cuando es utilizable y su fecha de finalización de pedido es en el futuro. Una clave de licencia se EXPIRED cuando es utilizable pero su fecha de finalización de pedido ya pasó.

licenses[n].statusCause

string

Código de razón para una clave de licencia DENIED . Ops Manager devuelve uno de CLAIM_CONFLICT, CLAIM_REVOKEDo VERIFICATION_FAILED. Ops Manager establece este campo solo para una clave de licencia DENIED .

licenses[n].statusReason

string

Frase que describe por qué la clave de licencia es DENIED. Ops Manager establece este campo solo para una clave de licencia DENIED .

licenses[n].termEnd

string

Fecha y hora en que termina la cobertura de la clave de licencia. Este campo se null cuando la clave de licencia no tiene fecha de finalización.

licenses[n].grants

Arreglo de objetos

Concede que la clave de licencia contiene. Para una clave de licencia RELEASED o DENIED , Ops Manager devuelve las concesiones si la clave de licencia almacenada aún pasa la verificación. Este array está vacío cuando falla la verificación.

licenses[n].grants[n].grantType

string

Tipo de subvención, como contract.

licenses[n].grants[n].grantId

string

Identificador de la subvención. Este campo se null cuando el emisor no lo configura.

licenses[n].grants[n].startDate

string

Fecha y hora en que empieza la subvención.

licenses[n].grants[n].endDate

string

Fecha y hora en que finaliza la subvención.

licenses[n].grants[n].entitlements

Arreglo de objetos

Derechos que conlleva la subvención. Cada objeto utiliza los campos descritos para activeEntitlements.

activeEntitlements

Objeto

Derechos que están activos ahora, agrupados por tipo de derecho. Cada clave es un tipo de derecho, como exemption::telemetry. Cada valor es un array de objetos de derecho.

activeEntitlements.<type>[n].type

string

Tipo de derecho a favor.

activeEntitlements.<type>[n].productName

string

Nombre del producto al que se aplica el derecho. Este campo se null cuando el derecho no tiene nombre de producto.

activeEntitlements.<type>[n].active

booleano

Indica si el derecho está en vigor.

activeEntitlements.<type>[n].window

Objeto

Ventana de validez del derecho a la aplicación. El objeto contiene start y end campos de fecha. Este campo se null cuando la ventana no tiene límites.

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

ARTIFACT_MALFORMED

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.

ARTIFACT_SIGNATURE_INVALID

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.

ARTIFACT_UNTRUSTED

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.

ARTIFACT_CERTIFICATE_INVALID

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.

ARTIFACT_HOLDER_NOT_ALLOWED

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.

ARTIFACT_OUTDATED

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.

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}

Los siguientes ejemplos muestran los encabezados de respuesta y el cuerpo de respuesta de una solicitud exitosa.

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-alive
HTTP/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}

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": {}}

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": []}