/ /

Trabajos de recopilación de registros del servidor

/ /

Recursos

Trabajos de recopilación de registros del servidor

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Trabajos de recopilación de registros del servidor

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

Al crear una tarea de recopilación de registros de servidor de Ops Manager, Ops Manager inicia tareas en segundo plano para recopilar los registros solicitados de los servidores de destino. Cada servidor recopila sus registros localmente, los comprime y cifra, y almacena el resultado en la base de datos de la aplicación. Utilice este punto final para crear una nueva tarea.

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

Resource

POST /admin/omLogCollectionJobs

Roles necesarios

Requiere que el La API Key que llama a este endpoint tiene la Global Owner rol.

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 señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

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 `serverId` valores devueltos por List Active Ops Manager Servers. Si omite este campo o pasa una matriz vacía, Ops Manager recopila registros de todos los servidores activos.
`logTypes`	Arreglo de cadenas	Opcional	Tipos de registros a recopilar. Cada elemento debe tener uno de los siguientes valores: `APPLICATION` `HTTP_ACCESS` `MIGRATION` Si omite este campo o pasa una matriz vacía, Ops Manager recopilará todos los tipos de registro.
`sizeRequestedPerFileBytes`	Número	Opcional	Tamaño máximo sin comprimir, en bytes, por tipo de registro y por servidor. Debe ser mayor que 0. Si omite este campo, Ops Manager asignará automáticamente el almacenamiento configurado restante entre los servidores y tipos de registro solicitados.
`logCollectionFromDate`	string	Opcional	Inicio del intervalo de tiempo para recopilar, en formato ISO 8601 UTC. Si configura este campo, también debe configurar `logCollectionToDate`.
`logCollectionToDate`	string	Opcional	Fin del intervalo de tiempo para recopilar, en formato ISO 8601 UTC. Si configura este campo, también debe configurar `logCollectionFromDate`.

Nota

Al combinar un límite de tamaño y un intervalo de tiempo, Ops Manager aplica el límite de tamaño como medida de seguridad. Si los registros dentro del intervalo de tiempo superan dicho límite, Ops Manager devuelve los registros más recientes hasta alcanzar el límite y establece sizeLimitHit en true en los trabajos secundarios afectados. Si omite sizeRequestedPerFileBytes junto con un intervalo de tiempo, Ops Manager asigna automáticamente el almacenamiento restante configurado entre los servidores y tipos de registro solicitados.

Ops Manager rechaza una solicitud de creación que infringe alguna 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 ser en el futuro.	`OM_LOG_TIME_RANGE_IN_FUTURE`	400
El intervalo de tiempo no debe exceder los 7 días.	`OM_LOG_TIME_RANGE_TOO_LARGE`	400
El intervalo 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 de Ops Manager registrado y activo.	`INACTIVE_SERVER` or `INVALID_SERVER`	400
El número de trabajos simultáneos no debe exceder de 4.	`TOO_MANY_OM_LOG_JOBS`	429
El espacio de almacenamiento estimado no debe exceder el límite de almacenamiento que el administrador de Ops Manager haya configurado para la recopilación de registros.	`OM_LOG_STORAGE_LIMIT_EXCEEDED`	413

Respuesta

Nombre	Tipo	Descripción
`id`	string	Identificador único del nuevo trabajo 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

Lista de servidores activos

Obtener todos los trabajos