Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Criar uma tarefa de coleção de registros

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 termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.

Use este ponto de extremidade para criar uma nova tarefa de coleção de log. Quando você cria uma tarefa de coleta de log, o MongoDB Ops Manager inicia uma tarefa em segundo plano para baixar os logs da implantação especificada do MongoDB Ops Manager.

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

POST /groups/{GROUP-ID}/logCollectionJobs
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.

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 está em um formato pretty-print.

false

envelope

booleano

Opcional

Sinalizador que indica se deve 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:

  • status: Código de resposta HTTP

  • content: Corpo de resposta esperado

false

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

inteiro

Opcional

Data e hora de início deste log, em milissegundos desde a Era UNIX. Se você especificar o logCollectionFromDate, também deverá especificar o logCollectionToDate.

logCollectionToDate

inteiro

Opcional

Data e hora em que este log deve terminar, em milésimos de segundo desde a Era UNIX. Se você especificar o logCollectionToDate, também deverá especificar o logCollectionFromDate.

Nome
Tipo
Descrição

id

string

Identificador único da job de collection de registros criada.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?pretty=true" \ --data ' { "resourceType": "PROCESS", "resourceName": "my_deployment_1", "redacted": true, "sizeRequestedPerFileBytes": 10000000, "logTypes": [ "FTDC", "MONGODB", "AUTOMATION_AGENT" ] }'
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "id": "5c81086e014b76a3d85e1113" }