Página inicial do Docs

/ /

Trabalhos de coleção de registro do servidor

Página inicial do Docs

/ /

Recursos

Trabalhos de coleção de registro do servidor

Página inicial do Docs

Trabalhos de coleção de registro do servidor

Obter todos os trabalhos de coleção de registro do servidor do Ops Manager

Use esse endpoint para recuperar cada tarefa de coleção de registro do servidor Ops Manager .

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

Resource

GET /admin/omLogCollectionJobs

Funções obrigatórias

Requer que a chave deAPI que chama esse endpoint tenha a função Global Read Only .

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

Solicitar parâmetros de query

Nome	Tipo	necessidade	Descrição	Default
`pageNum`	número	Opcional	Um inteiro baseado que retorna uma subseção de resultados.	`1`
`itemsPerPage`	número	Opcional	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
`verbose`	booleano	Opcional	Sinalizador que indica se todos os trabalhos filhos devem ser incluídos na resposta. Cada tarefa de coleção de registro de servidor do Ops Manager tem um tarefa filho para cada combinação de servidor e tipo de log incluída na solicitação.	`false`
`pretty`	booleano	Opcional	Sinalizador que indica se o corpo da resposta deve estar em um formato pretty-print.	`false`
`envelope`	booleano	Opcional	Sinalizador que indica se a resposta deve ser agrupada em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure `envelope=true` na query.	`false`

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

A resposta inclui uma array de objetos de resultado, uma array de objetos de link e o número total de objetos de resultado recuperados.

Nome	Tipo	Descrição
`results`	array	Array de trabalhos de coleção de registro do servidor do Ops Manager. Veja o documento incorporado de resultados.
`links`	array	Array de um ou mais links para sub-recursos ou recursos relacionados. As relações entre URLs seguem a Especificação de Link da Web 5988 (RFC).
`totalCount`	número	Número total de itens no conjunto de resultados. Pode exceder o tamanho de `results` quando paginado.

documento incorporado de resultados

Cada elemento results representa um tarefa de collection de registro do servidor do Ops Manager.

Nome	Tipo	Descrição
`id`	string	String única de 24dígitos hexadecimais que identifica esta tarefa.
`status`	string	Status da tarefa. Retorna um dos seguintes valores: `SUCCESS` `FAILURE` `IN_PROGRESS` `MARKED_FOR_EXPIRY` `EXPIRED`
`creationDate`	string	Timestamp, no formato ISO 8601 UTC, quando o Ops Manager criou o tarefa.
`expirationDate`	string	Registro de data/hora, no formato ISO 8601 UTC, quando o tarefa expira e o Ops Manager exclui automaticamente seus dados.
`finishDate`	string	Timestamp, no formato ISO 8601 UTC, quando o tarefa foi concluído. `null` enquanto a tarefa está em andamento.
`servers`	array de strings	Lista de `serverId` valores incluídos nesta solicitação. Retornado por Listar servidores do Active Ops Manager.
`logTypes`	array de strings	Tipos de registro incluídos nesta solicitação. Retorna um ou mais dos seguintes valores: `APPLICATION` `HTTP_ACCESS` `MIGRATION`
`sizeRequestedPerFileBytes`	número	Tamanho máximo solicitado, em bytes, por tipo de registro por servidor.
`logCollectionFromDate`	string	Início do filtro de intervalo de tempo, no formato ISO 8601 UTC. `null` se a solicitação não especificar um intervalo de tempo.
`logCollectionToDate`	string	Fim do filtro de intervalo de tempo, no formato ISO 8601 UTC. `null` se a solicitação não especificar um intervalo de tempo.
`uncompressedSizeTotalBytes`	número	Tamanho total descompactado, em bytes, dos dados de registro coletados.
`sizeLimitHit`	booleano	Sinalizador que indica se o Ops Manager truncado dados coletados de qualquer trabalho filho porque os dados alcançaram `sizeRequestedPerFileBytes`.
`downloadUrl`	string	URL do qual você pode baixar o arquivo. Consulte Baixar registros do servidor do Ops Manager.
`childJobs`	array	Lista de tarefas filhas associadas a esta solicitação. O gerente de operações inclui esse campo somente quando você define `verbose=true`.

Documento incorporado dochildJobs

Cada tarefa filho representa a tarefa de coleção de log para um servidor e um tipo de log.

Nome	Tipo	Descrição
`childJobs[n].serverId`	string	`serverId` do servidor Ops Manager do qual esse tarefa filho coleta registros.
`childJobs[n].logCollectionType`	string	Tipo de registro que esse tarefa filho coleta. Retorna um dos seguintes valores: `APPLICATION` `HTTP_ACCESS` `MIGRATION`
`childJobs[n].status`	string	Status desta tarefa. Retorna um dos seguintes valores: `SUCCESS` `FAILURE` `IN_PROGRESS` `MARKED_FOR_EXPIRY` `EXPIRED`
`childJobs[n].startDate`	string	Timestamp, no formato ISO 8601 UTC, quando esse tarefa filho começou.
`childJobs[n].finishDate`	string	Timestamp, no formato ISO 8601 UTC, quando este tarefa secundário foi concluído. `null` enquanto a tarefa secundária está em andamento.
`childJobs[n].errorMessage`	string	Mensagem de erro que explica por que esse tarefa filho falhou. `null` se a tarefa secundária não falhar.
`childJobs[n].sizeLimitHit`	booleano	Sinalizador que indica se o Ops Manager truncado os dados coletados deste trabalho filho porque os dados alcançaram `sizeRequestedPerFileBytes`.
`childJobs[n].uncompressedDiskspaceBytes`	número	Total de espaço em disco descompactado, em bytes, que este tarefa filho utiliza.

Exemplo de solicitação

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"

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

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

Voltar

criar

Obter um trabalho