/ /

Trabajos de colección de registros del servidor

/ /

Recursos

Trabajos de colección de registros del servidor

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Trabajos de colección de registros del servidor

Crear un trabajo de recopilación de registros del servidor de Ops Manager

Cuando creas una tarea de colección de registros del servidor en Ops Manager, este inicia tareas en segundo plano para recopilar los registros solicitados de los servidores objetivo. Cada servidor recopila sus registros localmente, los comprime y cifra, y los almacena en la base de datos de la aplicación. Usa este endpoint para crear una nueva tarea.

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

Resource

POST /admin/omLogCollectionJobs

Roles necesarios

Requiere que la clave API que llame a este endpoint tenga el rol Global Owner.

Request Parameters

Parámetros de ruta de solicitud

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

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint.

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:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Necesidad	Descripción
`servers`	Arreglo de cadenas	Opcional	Lista de valores `serverId` devuelta por Listar servidores activos de Ops Manager. Si omites este campo o pasas un arreglo vacío, Ops Manager recolecta registros de todos los servidores activos.
`logTypes`	Arreglo de cadenas	Opcional	Tipos de registros a recopilar. Cada elemento debe ser uno de los siguientes valores: `APPLICATION` `HTTP_ACCESS` `MIGRATION` Si omites este campo o pasas un array vacío, Ops Manager recogerá todo tipo de registros.
`sizeRequestedPerFileBytes`	Número	Opcional	Tamaño máximo sin comprimir, en bytes, por tipo de registro por servidor. Debe ser mayor que 0. Si omite este campo, Ops Manager asigna automáticamente el almacenamiento configurado restante entre los servidores solicitados y los tipos de registro.
`logCollectionFromDate`	string	Opcional	Inicio del rango de tiempo para recopilar, en formato ISO 8601 UTC. Si estableces este campo, también debes establecer `logCollectionToDate`.
`logCollectionToDate`	string	Opcional	Fin del rango de tiempo para recopilar, en formato ISO 8601 UTC. Si establece este campo, también debe establecer `logCollectionFromDate`.

Nota

Cuando combine un límite de tamaño y un rango de tiempo, Ops Manager aplica el límite de tamaño como un tope de seguridad. Si los registros en el rango de tiempo exceden el límite de tamaño, Ops Manager devuelve los registros más recientes hasta el límite de tamaño y establece sizeLimitHit en true en los trabajos secundarios afectados. Si omites sizeRequestedPerFileBytes junto con un intervalo de tiempo, Ops Manager asigna automáticamente el almacenamiento configurado restante entre los servidores y tipos de registro solicitados.

Ops Manager rechaza una solicitud de creación que infringe una de estas reglas:

Norma	Código de error	HTTP status
`sizeRequestedPerFileBytes` Debe ser mayor que 0.	`INVALID_LOG_REQUEST_SIZE`	400
`logCollectionFromDate` y `logCollectionToDate` deben configurarse juntos.	`OM_LOG_INCOMPLETE_TIME_RANGE`	400
`logCollectionFromDate` must precede `logCollectionToDate`.	`OM_LOG_INVALID_TIME_RANGE`	400
`logCollectionFromDate` no debe estar en el futuro.	`OM_LOG_TIME_RANGE_IN_FUTURE`	400
El rango de tiempo no debe exceder los 7 días.	`OM_LOG_TIME_RANGE_TOO_LARGE`	400
El rango de tiempo no debe comenzar antes del historial máximo de registros que haya configurado el administrador de Ops Manager.	`OM_LOG_TIME_RANGE_TOO_OLD`	400
Cada valor en `servers` debe identificar un servidor activo y registrado de Ops Manager.	`INACTIVE_SERVER` or `INVALID_SERVER`	400
El número de tareas concurrentes no debe exceder 4.	`TOO_MANY_OM_LOG_JOBS`	429
El almacenamiento estimado no debe exceder el límite de almacenamiento que el administrador de Ops Manager ha configurado para la colección de registros.	`OM_LOG_STORAGE_LIMIT_EXCEEDED`	413

Respuesta

Nombre	Tipo	Descripción
`id`	string	Identificador único de la nueva tarea de recopilación de registros del servidor de Ops Manager.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs?pretty=true" \
     --data '
       {
         "servers": [
           "om-server-1.example.com",
           "om-server-2.example.com"
         ],
         "logTypes": ["APPLICATION", "HTTP_ACCESS"],
         "sizeRequestedPerFileBytes": 5242880,
         "logCollectionFromDate": "2026-04-13T10:00:00Z",
         "logCollectionToDate": "2026-04-14T10:00:00Z"
       }'

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 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}

Respuesta del cuerpo

{ "id": "675a1234567890abcdef1234" }

Volver

Enumerar servidores activos

Obtener todos los trabajos