/ /

Trabalhos de coleção de registro do servidor

/ /

Recursos

Trabalhos de coleção de registro do servidor

Página inicial do Docs

Trabalhos de coleção de registro do servidor

Criar um trabalho de coleção de registros do servidor do Ops Manager

Quando você cria um tarefa de coleção de registro de servidor do Ops Manager, o Ops Manager inicia tarefas em segundo plano para coletar os registros solicitados dos servidores de destino. Cada servidor coleta seus registros localmente, os compacta, criptografa e armazena o resultado no banco de dados de aplicativos. Use este endpoint para criar um novo tarefa.

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

Resource

POST /admin/omLogCollectionJobs

Funções obrigatórias

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

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

Os seguintes parâmetros de query são opcionais:

Nome

Tipo

necessidade

Descrição

Default

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 deseja ou não envolver a resposta 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, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome	Descrição
`status`	Código de resposta HTTP
`content`	Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

Nome	Tipo	necessidade	Descrição
`servers`	array de strings	Opcional	Lista de `serverId` valores retornados por Listar servidores do Active Ops Manager. Se você omitir esse campo ou passar uma array vazia, o Ops Manager coletará registros de cada servidor ativo.
`logTypes`	array de strings	Opcional	Tipos de registro para coletar. Cada elemento deve ser um dos seguintes valores: `APPLICATION` `HTTP_ACCESS` `MIGRATION` Se você omitir esse campo ou passar uma array vazia, o Ops Manager coletará todos os tipos de registro.
`sizeRequestedPerFileBytes`	número	Opcional	Tamanho máximo descompactado, em bytes, por tipo de registro por servidor. Deve ser maior que 0. Se você omitir esse campo, o Ops Manager alocará automaticamente o armazenamento configurado restante nos servidores e tipos de registro solicitados.
`logCollectionFromDate`	string	Opcional	Início do intervalo de tempo a ser coletado, no formato ISO 8601 UTC. Se você definir este campo, também deverá definir `logCollectionToDate`.
`logCollectionToDate`	string	Opcional	Fim do intervalo de tempo a ser coletado, no formato ISO 8601 UTC. Se você definir este campo, também deverá definir `logCollectionFromDate`.

Observação

Quando você combina um limite de tamanho e um intervalo de tempo, o Ops Manager aplica o limite de tamanho como um limite de segurança. Se os registros no intervalo de tempo excederem o limite de tamanho, o Ops Manager retornará os registros mais recentes até o limite de tamanho e definirá sizeLimitHit como true nos trabalhos filhos afetados. Se você omitir sizeRequestedPerFileBytes ao lado de um intervalo de tempo, o Ops Manager alocará automaticamente o armazenamento configurado restante nos servidores e tipos de registro solicitados.

O gerente de operações rejeita uma solicitação de criação que viole uma destas regras:

Regra	Código de erro	HTTP status
`sizeRequestedPerFileBytes` deve ser maior que 0.	`INVALID_LOG_REQUEST_SIZE`	400
`logCollectionFromDate` e `logCollectionToDate` devem ser definidos juntos.	`OM_LOG_INCOMPLETE_TIME_RANGE`	400
`logCollectionFromDate` must precede `logCollectionToDate`.	`OM_LOG_INVALID_TIME_RANGE`	400
`logCollectionFromDate` não deve ser no futuro.	`OM_LOG_TIME_RANGE_IN_FUTURE`	400
O intervalo de tempo não deve exceder 7 dias.	`OM_LOG_TIME_RANGE_TOO_LARGE`	400
O intervalo de tempo não deve começar antes do histórico máximo de registro que o administrador do Ops Manager configurou.	`OM_LOG_TIME_RANGE_TOO_OLD`	400
Cada valor em `servers` deve identificar um servidor registrado e ativo do Ops Manager.	`INACTIVE_SERVER` ou `INVALID_SERVER`	400
O número de tarefas simultâneas não deve exceder 4.	`TOO_MANY_OM_LOG_JOBS`	429
O armazenamento estimado não deve exceder o limite de armazenamento que o administrador do Ops Manager configurou para a coleção de registros.	`OM_LOG_STORAGE_LIMIT_EXCEEDED`	413

Resposta

Nome	Tipo	Descrição
`id`	string	Identificador exclusivo da nova tarefa de coleta de registro do servidor do Ops Manager .

Exemplo de solicitação

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

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

Corpo de resposta

{ "id": "675a1234567890abcdef1234" }

Voltar

Listar servidores ativos

Obter todos os trabalhos