Baixar registros de uma tarefa de coleção de registros
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
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 registros, o Cloud Manager inicia uma tarefa em segundo plano para baixar os registros da implantação do Cloud 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 jobs 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 para o mesmo diretório onde a solicitação é executada e no mesmo formato usado ao baixar registros por meio da interface do usuário do Cloud 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://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}/download
Parâmetros do caminho da solicitação
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 |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato. |
| ||||||
envelope | booleano | 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:
|
|
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Este endpoint não tem elementos de resposta.
Exemplo de solicitação
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest 2 --header "Accept: application/json" 3 --header "Accept: application/gzip" 4 --output logs.tar.gz 5 --request GET "https://cloud.mongodb.com/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.
Exemplo de resposta
Cabeçalho de resposta
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
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
Este endpoint não retorna um corpo de resposta.