Docs Home

/ /

Trabajos de recopilación de registros del servidor

Docs Home

/ /

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

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

Utilice 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 especifica si se deben incluir todos los subprocesos en la respuesta. Cada trabajo de recopilación de registros del servidor de Ops Manager tiene un subproceso 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	Indicador que especifica si se debe encapsular la respuesta. Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, establezca `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 una matriz de objetos de resultado, una matriz de objetos de enlace y el número total de objetos de resultado recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	Conjunto de trabajos de recopilación de registros del servidor de Ops Manager. Consulte los resultados en el documento adjunto.
`links`	arreglo	Conjunto de uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URL siguen la especificación de enlaces web 5988 (RFC).
`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 un trabajo de recopilación de registros del servidor de Ops Manager.

Nombre	Tipo	Descripción
`id`	string	Cadena única de dígitos hexadecimales 24que identifica este trabajo.
`status`	string	Estado del trabajo. 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ó el trabajo.
`expirationDate`	string	Marca de tiempo, en formato ISO 8601 UTC, cuando el trabajo expira y Ops Manager elimina automáticamente sus datos.
`finishDate`	string	Marca de tiempo, en formato ISO 8601 UTC, cuando el trabajo finalizó. `null` mientras el trabajo está en curso.
`servers`	Arreglo de cadenas	Lista de `serverId` valores incluidos en esta solicitud. Devuelto por List Active Ops Manager Servers.
`logTypes`	Arreglo de cadenas	Tipos de registro incluidos en esta solicitud. Devuelve uno o más de los siguientes valores: `APPLICATION` `HTTP_ACCESS` `MIGRATION`
`sizeRequestedPerFileBytes`	Número	Tamaño máximo solicitado, en bytes, por tipo de registro y por servidor.
`logCollectionFromDate`	string	Inicio del filtro de rango de tiempo, en formato ISO 8601 UTC. `null` si la solicitud no especificó 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 registro recopilados.
`sizeLimitHit`	booleano	Indicador que señala si Ops Manager truncó los datos recopilados de algún trabajo secundario porque los datos alcanzaron `sizeRequestedPerFileBytes`.
`downloadUrl`	string	URL desde la que puede descargar el archivo. Consulte Descargar registros del servidor de Ops Manager.
`childJobs`	arreglo	Lista de trabajos secundarios asociados a esta solicitud. Ops Manager incluye este campo solo cuando se establece `verbose=true`.

Documento incrustado de childJobs

Cada tarea secundaria representa la tarea de recopilación de registros para un servidor y un tipo de registro.

Nombre	Tipo	Descripción
`childJobs[n].serverId`	string	`serverId` del servidor de Ops Manager desde el cual este trabajo secundario recopila registros.
`childJobs[n].logCollectionType`	string	Tipo de registro que recopila este trabajo secundario. Devuelve uno de los siguientes valores: `APPLICATION` `HTTP_ACCESS` `MIGRATION`
`childJobs[n].status`	string	Estado de este trabajo secundario. Devuelve uno de los siguientes valores: `SUCCESS` `FAILURE` `IN_PROGRESS` `MARKED_FOR_EXPIRY` `EXPIRED`
`childJobs[n].startDate`	string	Marca de tiempo, en formato ISO 8601 UTC, cuando comenzó este trabajo secundario.
`childJobs[n].finishDate`	string	Marca de tiempo, en formato ISO 8601 UTC, cuando finalizó este trabajo secundario. `null` mientras el trabajo secundario está en curso.
`childJobs[n].errorMessage`	string	Mensaje de error que explica por qué falló este trabajo secundario. `null` si el trabajo secundario no falló.
`childJobs[n].sizeLimitHit`	booleano	Indicador que señala si Ops Manager truncó los datos recopilados de este trabajo secundario porque los datos alcanzaron `sizeRequestedPerFileBytes`.
`childJobs[n].uncompressedDiskspaceBytes`	Número	Espacio total en disco sin comprimir, en bytes, que utiliza este proceso secundario.

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

Consigue un trabajo