Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos
/
Trabalhos de coleção de registros

Obter uma tarefa de collection de registros

Nesta página

  • Resource
  • 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 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 recuperar uma única tarefa de collection de registro por seu identificador exclusivo.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}

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

String única de 24 dígitos hexadecimais que identifica a job de collection de registros para tentar novamente. Use o endpoint Get All Log collection Jobs for One projeto para obter os ID associados ao seu projeto.

Solicitar parâmetros de query

Nome
Tipo
Descrição
Default

pageNum

inteiro

Número da página (com base em índice 1).

1

itemsPerPage

inteiro

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Indica se o corpo da resposta deve estar em um prettyprint formato.

false

envelope

booleano

Indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure "envelope" : true na consulta.

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

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Cloud Manager adiciona o campo status ao corpo da resposta.

none

verbose

Boolean

Se verdadeiro, retorna todas as tarefas filhas na resposta. Uma tarefa de collection de registro contém tarefas filhos para cada tipo de registro e processo MongoDB incluído na solicitação.

false

Parâmetros do corpo da solicitação

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

Resposta

Nome
Tipo
Descrição

childJobs

array

Lista de tarefa filhos associados a esta solicitação. Incluído na resposta se você configurar o parâmetro de query detalhado para true.

clientJobs[n].errorMessage

string

Mensagem de erro mostrando por que essa tarefa filho falhou, se aplicável.

childJobs[n].finishDate

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando essa tarefa secundária for concluída.

clientJobs[n].hostName

string

Nome do host de quem a tarefa filho coleta os logs.

clientJobs[n].logCollectionType

string

Tipo de registro que esta tarefa filho coleta. Retorna um dos seguintes valores:

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

clientJobs[n].path

string

Caminho para o processo no sistema para o qual essa tarefa filha coleta registros. O MongoDB Atlas utiliza esses caminhos para construir a hierarquia de diretório no arquivo compactado.

logCollectionType
Caminho

Automation_agent

<hostname>/automation_agent

BACKUP_AGENT

<hostname>/automation_agent

MONITORING_AGENT

<hostname>/automation_agent

MongoDB

<hostname>/<port>/<mongodb>

FTDC

<hostname>/<port>/<ftdc>

clientJobs[n].startDate

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando essa tarefa secundária começou.

clientJobs[n].status

string

Status desta tarefa filho. Este recurso retorna um dos seguintes valores:

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

clientJobs[n].uncompressedDiskspaceBytes

número

Espaço total em disco descompactado em bytes que esta tarefa filho utiliza.

creationDate

string

Registro de data/hora, em segundos decorridos desde a UNIX epoch quando você criou o trabalho de solicitação de collection de registro.

Data de expiração

string

Registro de data/hora, em segundos decorridos desde a UNIX epoch quando o trabalho de solicitação de collection de registro expira.

groupId

string

24única - string de dígitos hexadecimais que identifica o projeto associado à solicitação de coleção de registro.

id

string

String exclusiva de 24 dígitos hexadecimais que identifica a job de solicitação de collection de registros.

logTypes

array

Lista de tipos de registro incluídos nesta solicitação. Este recurso retorna um ou mais dos seguintes valores:

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

editado

booleano

Sinalizador que indica se a solicitação substitui e-mails, nomes de host, endereços IP e namespaces na resposta por valores de string aleatórios.

Nome do recurso

string

Nome do recurso para o qual você solicitou registros.

recursoType

string

Tipo de recurso para o qual você solicitou registros. Este recurso retorna um dos seguintes valores:

  • CLUSTER

  • PROCESS

  • REPLICA_SET

rootResourceName

string

Nome da implantação completa se você fez a solicitação de registro para uma parte de uma implantação. Parte da implantação pode ser um conjunto de réplicas em um cluster ou um fragmento de um cluster fragmentado.

rootResourceType

string

Tipo da parte do sistema completo se você fez a solicitação de registro para uma parte de um sistema. Parte da implantação pode ser um conjunto de réplicas em um cluster ou um fragmento de um cluster fragmentado. Este recurso retorna um dos seguintes valores:

  • CLUSTER

  • PROCESS

  • REPLICA_SET

Status

string

Status da tarefa de solicitação de coleção de registro. Este recurso retorna um dos seguintes valores:

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

sizeRequestedPerFileBytes

número

Tamanho de cada arquivo de log em bytes.

uncompressedSizeTotalBytes

número

Tamanho total descompactado dos dados de registro em bytes que essa solicitação retorna.

ID do usuário

string

String exclusiva de 24 dígitos hexadecimais que identifica o usuário que executa a solicitação.

URL

string

Endereço de Internet do qual você baixa os registros desta solicitação.

logCollectionFromDate

string

A data e a hora de início da coleta de registros na ISO 8601 formato (UTC).

logCollectionToDate

string

A data e a hora finais da collection de registros na ISO 8601 formato (UTC).

Exemplo de solicitação

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --include \
4     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}?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

1{
2  "childJobs": [
3    {
4      "automationAgentId": "5c81086e014b76a3d85e1123",
5      "errorMessage": null,
6      "finishDate": "2019-03-07T12:02:57Z",
7      "hostName": "server1.example.com",
8      "logCollectionType": "AUTOMATION_AGENT",
9      "path": "server1.example.com/automation_agent",
10      "startDate": "2019-03-07T12:02:54Z",
11      "status": "SUCCESS",
12      "uncompressedDiskSpaceBytes": 12827
13    },
14    {
15      "automationAgentId": "5c81086e014b76a3d85e1117",
16      "errorMessage": null,
17      "finishDate": "2019-03-07T12:02:57Z",
18      "hostName": "server1.example.com:27027",
19      "logCollectionType": "MONGODB",
20      "path": "server1.example.com/27027/mongodb",
21      "startDate": "2019-03-07T12:02:54Z",
22      "status": "SUCCESS",
23      "uncompressedDiskSpaceBytes": 9292
24    },
25    ...
26  ],
27  "creationDate": "2019-03-07T12:02:54Z",
28  "downloadUrl": "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download",
29  "expirationDate": "2019-05-06T12:02:54Z",
30  "groupId": "5c8100bcf2a30b12ff88258f",
31  "id": "5c81086e014b76a3d85e1113",
32  "logTypes": [
33    "AUTOMATION_AGENT",
34    "MONGODB",
35    "FTDC"
36  ],
37  "redacted": false,
38  "resourceName": "myReplicaSet",
39  "resourceType": "replicaset",
40  "rootResourceName": "myReplicaSet",
41  "rootResourceType": "replicaset",
42  "sizeRequestedPerFileBytes": 1000,
43  "status": "IN_PROGRESS",
44  "uncompressedSizeTotalBytes": 44518,
45  "userId": "5c80f75fcf09a246878f67a4"
46}

Voltar

Obter todos os trabalhos

Próximo

Baixar registros