Docs Home

/ /

Trabajos de colección de registros del servidor

Docs Home

/ /

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

Obtener todos los trabajos de recopilación de registros del servidor de Ops Manager

Utiliza este punto final para recuperar todos los trabajos de recopilación de registros del servidor de Ops Manager.

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

Resource

GET /admin/omLogCollectionJobs

Roles necesarios

Requiere que el La API Key que llama a este endpoint tiene la Global Read Only 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

Nombre	Tipo	Necesidad	Descripción	predeterminado
`pageNum`	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
`itemsPerPage`	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
`verbose`	booleano	Opcional	Indicador que determina si se deben incluir todas las tareas secundarias en la respuesta. Cada tarea de colección de registros del servidor Ops Manager tiene una tarea secundaria para cada combinación de servidor y tipo de registro incluida en la solicitud.	`false`
`pretty`	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 envolver la respuesta en un sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta o al código de estado de HTTP. Para remediar esto, establecer `envelope=true` en la consulta.	`false`

Parámetros del cuerpo de la solicitud

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

Respuesta

La respuesta incluye un arreglo de objetos de resultados, un arreglo de objetos de enlaces y el número total de objetos de resultados recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	Arreglo de tareas de colección de registros de servidores de Ops Manager. Consulta resultados Documento incrustado.
`links`	arreglo	Arreglo de uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre URLs siguen la especificación de enlaces web (RFC 5988).
`totalCount`	Número	Número total de elementos en el conjunto de resultados. Puede exceder el tamaño de `results` cuando se pagina.

resultados Documento incrustado

Cada elemento results representa una tarea de colección de registros de un servidor Ops Manager.

Nombre	Tipo	Descripción
`id`	string	Unique 24-hexadecimal digit string que identifica esta tarea.
`status`	string	Estado de la tarea. Devuelve uno de los siguientes valores: `SUCCESS` `FAILURE` `IN_PROGRESS` `MARKED_FOR_EXPIRY` `EXPIRED`
`creationDate`	string	Marca de tiempo, en formato ISO 8601 UTC, cuando Ops Manager creó la tarea.
`expirationDate`	string	Marca de tiempo, en formato ISO 8601 UTC, cuando la tarea vence y Ops Manager elimina automáticamente sus datos.
`finishDate`	string	Marca de tiempo, en formato ISO 8601 UTC, cuando se completó la tarea. `null` mientras se realiza la tarea.
`servers`	Arreglo de cadenas	Lista de valores de `serverId` incluidos en esta solicitud. Devolución de Listar servidores activos de Ops Manager.
`logTypes`	Arreglo de cadenas	Tipos de registros incluidos en esta solicitud. Devuelve uno o varios de los siguientes valores: `APPLICATION` `HTTP_ACCESS` `MIGRATION`
`sizeRequestedPerFileBytes`	Número	Tamaño máximo solicitado, en bytes, por tipo de registro por servidor.
`logCollectionFromDate`	string	Inicio del filtro de rango de tiempo, en formato ISO 8601 UTC. `null` si la solicitud no especificaba un rango de tiempo.
`logCollectionToDate`	string	Fin del filtro de rango de tiempo, en formato ISO 8601 UTC. `null` si la solicitud no especificó un rango de tiempo.
`uncompressedSizeTotalBytes`	Número	Tamaño total sin comprimir, en bytes, de los datos de registros recopilados.
`sizeLimitHit`	booleano	Indicador que señala si Ops Manager truncó los datos recopilados de alguna tarea secundaria porque los datos alcanzaron `sizeRequestedPerFileBytes`.
`downloadUrl`	string	URL desde la que puedes descargar el fichero. Consulta Descargar los registros del servidor de Ops Manager.
`childJobs`	arreglo	Lista de tareas secundarias asociadas con esta solicitud. Ops Manager incluye este campo solo cuando se establece `verbose=true`.

childJobs documento incrustado

Cada tarea secundario representa la tarea de colección de registro para un servidor y un tipo de registro.

Nombre	Tipo	Descripción
`childJobs[n].serverId`	string	`serverId` del servidor de Ops Manager del cual este subproceso de trabajo recopila registros.
`childJobs[n].logCollectionType`	string	Tipo de registro que recoge esta tarea secundaria. Devuelve uno de los siguientes valores: `APPLICATION` `HTTP_ACCESS` `MIGRATION`
`childJobs[n].status`	string	Estado de esta tarea secundaria. Devuelve uno de los siguientes valores: `SUCCESS` `FAILURE` `IN_PROGRESS` `MARKED_FOR_EXPIRY` `EXPIRED`
`childJobs[n].startDate`	string	Marca de tiempo, en formato UTC ISO 8601, cuando se inició esta tarea secundaria.
`childJobs[n].finishDate`	string	Marca de tiempo, en formato ISO 8601 UTC, cuando esta tarea secundaria finalizó. `null` mientras la tarea secundaria está en curso.
`childJobs[n].errorMessage`	string	Mensaje de error que explica la razón por la cual esta tarea secundaria falló. `null` si la tarea secundario no falló.
`childJobs[n].sizeLimitHit`	booleano	Bandera que indica si Ops Manager truncó los datos recogidos de esta tarea secundaria porque los datos alcanzaron `sizeRequestedPerFileBytes`.
`childJobs[n].uncompressedDiskspaceBytes`	Número	El espacio total no comprimido en disco, en bytes, que utiliza esta tarea secundaria.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs?verbose=true&pretty=true"

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 200 OK
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

{
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs?verbose=true&pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "id": "675a1234567890abcdef1234",
      "status": "SUCCESS",
      "creationDate": "2026-04-13T10:00:00Z",
      "expirationDate": "2026-04-20T10:00:00Z",
      "finishDate": "2026-04-13T10:02:30Z",
      "servers": [
        "om-server-1.example.com",
        "om-server-2.example.com"
      ],
      "logTypes": ["APPLICATION", "HTTP_ACCESS"],
      "sizeRequestedPerFileBytes": 5242880,
      "logCollectionFromDate": null,
      "logCollectionToDate": null,
      "uncompressedSizeTotalBytes": 8388608,
      "sizeLimitHit": true,
      "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs/675a1234567890abcdef1234:download",
      "childJobs": [
        {
          "serverId": "om-server-1.example.com",
          "logCollectionType": "APPLICATION",
          "status": "SUCCESS",
          "startDate": "2026-04-13T10:00:05Z",
          "finishDate": "2026-04-13T10:01:30Z",
          "errorMessage": null,
          "sizeLimitHit": true,
          "uncompressedDiskspaceBytes": 5242880
        },
        {
          "serverId": "om-server-1.example.com",
          "logCollectionType": "HTTP_ACCESS",
          "status": "SUCCESS",
          "startDate": "2026-04-13T10:00:05Z",
          "finishDate": "2026-04-13T10:01:45Z",
          "errorMessage": null,
          "sizeLimitHit": false,
          "uncompressedDiskspaceBytes": 2097152
        },
        {
          "serverId": "om-server-2.example.com",
          "logCollectionType": "APPLICATION",
          "status": "FAILURE",
          "startDate": "2026-04-13T10:00:10Z",
          "finishDate": "2026-04-13T10:00:45Z",
          "errorMessage": "Failed to read log file: permission denied",
          "sizeLimitHit": false,
          "uncompressedDiskspaceBytes": 0
        },
        {
          "serverId": "om-server-2.example.com",
          "logCollectionType": "HTTP_ACCESS",
          "status": "SUCCESS",
          "startDate": "2026-04-13T10:00:10Z",
          "finishDate": "2026-04-13T10:02:00Z",
          "errorMessage": null,
          "sizeLimitHit": false,
          "uncompressedDiskspaceBytes": 1048576
        }
      ]
    }
  ],
  "totalCount": 1
}

Volver

Crear

GET un trabajo