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
Resource
POST /groups/{GROUP-ID}/logCollectionJobsParâ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 que indica se o corpo da resposta está em um formato pretty-print. |
|
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:
|
|
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:
|
Nome do recurso | string | Obrigatório | Nome do recurso do qual coletar registros. O tipo de recurso define o valor:
|
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:
|
editado | booleano | Obrigatório | Se definido como |
logCollectionFromDate | inteiro | Opcional | Data e hora de início deste log, em milissegundos desde a Era UNIX. Se você especificar o |
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 |
Resposta
Nome | Tipo | Descrição |
|---|---|---|
id | string | Identificador único da job de collection de registros criada. |
Exemplo de solicitação
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" ] }'Exemplo de resposta
Cabeçalho de resposta
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-aliveHTTP/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}Corpo de resposta
{ "id": "5c81086e014b76a3d85e1113" }