Use esse endpoint para recuperar um único tarefa de coleção de registros do servidor do Ops Manager por seu identificador.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/omLogCollectionJobs/{JOB-ID}
Funções obrigatórias
Requer que a chave deAPI que chama esse endpoint tenha a função Global Read Only .
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
| string | Obrigatório | 24String exclusiva de dígitos hexadecimais que identifica a tarefa de collection de registro do servidor do Ops Manager. Para encontrar um ID de tarefa , chame Obter todos os trabalhos de coleção de registro do servidor do Ops Manager. |
Solicitar parâmetros de query
Nome | Tipo | necessidade | Descrição | Default |
|---|---|---|---|---|
| booleano | Opcional | Sinalizador que indica se todos os trabalhos filhos devem ser incluídos na resposta. |
|
| booleano | Opcional |
| |
| booleano | Opcional | Sinalizador que indica se a resposta deve ser agrupada 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, configure |
|
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
A resposta retorna um único tarefa de collection de registro do servidor do Ops Manager .
Nome | Tipo | Descrição |
|---|---|---|
| string | String única de 24dígitos hexadecimais que identifica esta tarefa. |
| string | Status da tarefa. Retorna um dos seguintes valores:
|
| string | Timestamp, no formato ISO 8601 UTC, quando o Ops Manager criou o tarefa. |
| string | Registro de data/hora, no formato ISO 8601 UTC, quando o tarefa expira e o Ops Manager exclui automaticamente seus dados. |
| string | Timestamp, no formato ISO 8601 UTC, quando o tarefa foi concluído. |
| array de strings | Lista de |
| array de strings | Tipos de registro incluídos nesta solicitação. Retorna um ou mais dos seguintes valores:
|
| número | Tamanho máximo solicitado, em bytes, por tipo de registro por servidor. |
| string | Início do filtro de intervalo de tempo, no formato ISO 8601 UTC. |
| string | Fim do filtro de intervalo de tempo, no formato ISO 8601 UTC. |
| número | Tamanho total descompactado, em bytes, dos dados de registro coletados. |
| booleano | Sinalizador que indica se o Ops Manager truncado dados coletados de qualquer trabalho filho porque os dados alcançaram |
| string | URL do qual você pode baixar o arquivo. Consulte Baixar registros do servidor do Ops Manager. |
| array | Lista de tarefas filhas associadas a esta solicitação. O gerente de operações inclui esse campo somente quando você define |
Documento incorporado dochildJobs
Cada tarefa filho representa a tarefa de coleção de log para um servidor e um tipo de log.
Nome | Tipo | Descrição |
|---|---|---|
| string |
|
| string | Tipo de registro que esse tarefa filho coleta. Retorna um dos seguintes valores:
|
| string | Status desta tarefa. Retorna um dos seguintes valores:
|
| string | Timestamp, no formato ISO 8601 UTC, quando esse tarefa filho começou. |
| string | Timestamp, no formato ISO 8601 UTC, quando este tarefa secundário foi concluído. |
| string | Mensagem de erro que explica por que esse tarefa filho falhou. |
| booleano | Sinalizador que indica se o Ops Manager truncado os dados coletados deste trabalho filho porque os dados alcançaram |
| número | Total de espaço em disco descompactado, em bytes, que este tarefa filho utiliza. |
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs/{JOB-ID}?verbose=true&pretty=true"
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
{ "id": "675a1234567890abcdef1234", "status": "SUCCESS", "creationDate": "2026-04-13T10:00:00Z", "expirationDate": "2026-04-20T10:00:00Z", "finishDate": "2026-04-13T10:02:30Z", "servers": [ "om-server-1.example.com", "om-server-2.example.com" ], "logTypes": ["APPLICATION", "HTTP_ACCESS", "MIGRATION"], "sizeRequestedPerFileBytes": 5242880, "logCollectionFromDate": "2026-04-12T00:00:00Z", "logCollectionToDate": "2026-04-13T00:00:00Z", "uncompressedSizeTotalBytes": 15728640, "sizeLimitHit": false, "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs/675a1234567890abcdef1234:download", "childJobs": [ { "serverId": "om-server-1.example.com", "logCollectionType": "APPLICATION", "status": "SUCCESS", "startDate": "2026-04-13T10:00:05Z", "finishDate": "2026-04-13T10:01:30Z", "errorMessage": null, "sizeLimitHit": false, "uncompressedDiskspaceBytes": 2621440 }, { "serverId": "om-server-1.example.com", "logCollectionType": "HTTP_ACCESS", "status": "SUCCESS", "startDate": "2026-04-13T10:00:05Z", "finishDate": "2026-04-13T10:02:00Z", "errorMessage": null, "sizeLimitHit": false, "uncompressedDiskspaceBytes": 1310720 }, { "serverId": "om-server-1.example.com", "logCollectionType": "MIGRATION", "status": "SUCCESS", "startDate": "2026-04-13T10:00:05Z", "finishDate": "2026-04-13T10:01:15Z", "errorMessage": null, "sizeLimitHit": false, "uncompressedDiskspaceBytes": 524288 }, { "serverId": "om-server-2.example.com", "logCollectionType": "APPLICATION", "status": "SUCCESS", "startDate": "2026-04-13T10:00:10Z", "finishDate": "2026-04-13T10:02:30Z", "errorMessage": null, "sizeLimitHit": false, "uncompressedDiskspaceBytes": 3145728 } ] }