/ /

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

Baixar registros do servidor do Ops Manager

Use esse endpoint para baixar um arquivo .tar.gz que contém todos os arquivo de log que o Ops Manager coletou para a tarefa especificada. Você não pode fazer o download de um tarefa cujo status seja IN_PROGRESS ou EXPIRED. Se um tarefa falhar parcialmente, o arquivo incluirá somente os arquivos de log que o Ops Manager coletou com sucesso.

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

Resource

GET /admin/omLogCollectionJobs/{JOB-ID}:download

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

Nome	Tipo	necessidade	Descrição
`JOB-ID`	string	Obrigatório	24String exclusiva de dígitos hexadecimais que identifica a tarefa de collection de registro do servidor do Ops Manager. Para encontrar um ID de tarefa , chame Obter todos os trabalhos de coleção de registro do servidor do Ops Manager.

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

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

Resposta

Esse endpoint retorna um fluxo binário com Content-Type: application/gzip e o formato de nome de arquivo om-logs_{timestamp}.tar.gz. O arquivo usa o seguinte layout:

om-server-1.example.com/
   application/
      mms0.log
      mms0.20260412.log
   http_access/
      mms0-access.log
   migration/
      mms-migration.log
om-server-2.example.com/
   application/
      mms0.log
   http_access/
      mms0-access.log
      mms0-access.20260412.log

Importante

Ao chamar esse endpoint com curl, você deve passar --output e um nome de arquivo. Caso contrário, o curl grava o arquivo binário no seu terminal.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/gzip" \
     --output om-logs.tar.gz \
     --request GET \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs/{JOB-ID}:download"

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/gzip
Content-Disposition: attachment; filename="om-logs_{timestamp}.tar.gz"
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

Este endpoint não retorna um corpo de resposta JSON.

Voltar

Obter um trabalho

Estender expiração