Menu Docs

Página inicial do DocsMongoDB Ops Manager

Baixar registros de uma tarefa de coleção de registros

Nesta página

  • Recurso
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.

Quando você cria uma tarefa de collection de registro, o Ops Manager inicia uma tarefa em segundo plano para baixar os registros da implantação do Ops Manager especificado. Use esse endpoint para baixar um fluxo de arquivos .tar.gz para todos os registros associados à tarefa especificada.

Você pode baixar registros de tarefa de collection de registros bem-sucedidas e com falha. Se a tarefa falhar, todos os componentes bem-sucedidos serão baixados. Os registros são baixados no mesmo diretório onde a solicitação é executada e no mesmo formato usado ao baixar registros por meio da interface do usuário do Ops Manager.

Exemplo

hostname/
automation_agent/
Automation-agent-verbose.log.2019-01-...
mongos/
...
myShard_1/
27017/
...
27018/
...

Não é possível baixar registros de tarefas nos estados EXPIRED ou IN_PROGRESS .

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

GET /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}/download
Nome
Tipo
necessidade
Descrição
ID do grupo
string
Obrigatório
String exclusiva de 24 dígitos hexadecimais que identifica a job de solicitação de collection de registros.
tarefa-ID
string
Obrigatório
Identificador único da tarefa para a qual baixar os registros. Você pode obter o JOB-IDs associado ao seu projeto usando o endpoint Get All Log Collection for One Project .

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

Nome
Tipo
necessidade
Descrição
default
pretty
boleano
Opcional
Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato.
false
envelope
boleano
Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da 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
envelope
Corpo de resposta esperado
false

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

Este endpoint não tem elementos de resposta.

1curl --user "{username}:{apiKey}" --digest
2 --header "Accept: application/json"
3 --header "Accept: application/gzip"
4 --output logs.tar.gz
5 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}/download"

Observação

Se estiver usando o cURL para fazer solicitações, inclua a opção --output e especifique um nome de arquivo para armazenar seus registros.

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}

Este endpoint não retorna um corpo de resposta.

← Obter uma tarefa de collection de registros