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

Criar uma tarefa de coleção 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 criar um novo trabalho de coleção de registro.

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

Resource

POST /groups/{GROUP-ID}/logCollectionJobs

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.

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.

false

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:

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

recursoType

string

Obrigatório

Tipo de recurso do qual coletar registros. Deve ser um dos seguintes valores:

  • CLUSTER, para um cluster fragmentado.

  • PROCESS, para um nó no conjunto de réplicas.

  • REPLICASET, para um conjunto de réplicas.'

Nome do recurso

string

Obrigatório

Nome do recurso do qual coletar registros. O tipo de recurso define o valor:

  • Para o CLUSTER resourceType, o valor é o nome da implantação ou o CLUSTER-ID. Por exemplo, my-deployment.

  • Para PROCESS resourceType, o valor é o nome do conjunto de réplicas seguido pelo nome do nó. Por exemplo, Cluster0-shard-1-node-0.

    Para obter o nome do conjunto de réplicas, a lista de nós e outras informações, acesse o cluster e execute rs.conf()._id e rs.status().

  • Para REPLICASET resourceType, o valor é o nome do conjunto de réplicas no cluster seguido pelo nome do shard. Por exemplo, test-123abc-shard-0.

sizeRequestedPerFileBytes

número

Obrigatório

Tamanho de cada arquivo de log em bytes.

logTypes

array

Obrigatório

Array de strings especificando os tipos de registros a serem coletados. Cada elemento de array deve ter um dos seguintes valores:

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

editado

booleano

Obrigatório

Se definido como true, e-mails, nomes de host, endereços IP e namespaces nas respostas da API que envolvem essa tarefa serão substituídos por valores de string aleatórios.

logCollectionFromDate

string

Opcional

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

logCollectionToDate

string

Necessário se estiver usando logCollectionFromDate.

A data e a hora finais da collection de registros na ISO 8601 formato (UTC). A data e a hora devem estar no passado. logCollectionToDate deve ser depois logCollectionFromDate.

Resposta

Nome
Tipo
Descrição

id

string

Identificador único da job de collection de registros criada.

Exemplo de solicitação

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?pretty=true"
6     --data '
7       {
8         "resourceType": "PROCESS",
9         "resourceName": "my_deployment_1",
10         "redacted": true,
11         "sizeRequestedPerFileBytes": 10000000,
12         "logTypes": [
13             "FTDC",
14             "MONGODB",
15             "AUTOMATION_AGENT"
16         ],
17         "logCollectionFromDate": "2024-07-18T13:53:17Z",
18         "logCollectionToDate": "2024-07-18T15:53:17Z"
19       }'

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

1{ "id": "5c81086e014b76a3d85e1113" }

Voltar

Baixar registros

Próximo

Ampliar