Descargar registros de una tarea de colección de registros

Nota

Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, el ID del grupo se mantiene igual. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El endpoint permanece tal como se indica en el documento.

Cuando se crea una tarea de colección de registros, el Ops Manager inicia una tarea en segundo plano para descargar los registros de la implementación específica de Ops Manager. Utilice este endpoint para descargar una secuencia de archivos .tar.gz para todos los registros asociados a la tarea especificada.

Puedes descargar los registros de las tareas de recolección de registros exitosas y fallidas. Si la tarea falló, todos los componentes exitosos se descargan. Los registros se descargan en el mismo directorio donde se ejecuta la solicitud, y en el mismo formato que se utiliza al descargar los registros a través de la interfaz de usuario de Ops Manager.

Ejemplo

hostname/
    automation_agent/
        Automation-agent-verbose.log.2019-01-...
    mongos/
        ...
    myShard_1/
        27017/
            ...
        27018/
...

No se pueden descargar registros de las tareas que se encuentran en los estados EXPIRED o IN_PROGRESS.

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

Resource

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

Parámetros de ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
ID del grupo	string	Requerido	Cadena única de 24 dígitos hexadecimales que identifica la tarea de solicitud de colección de registros.
JOB-ID	string	Requerido	Identificador único de la tarea para el que descargar los registros. Puedes obtener el `JOB-IDs` asociado con tu Proyecto utilizando el punto final Obtener todos los trabajos de colección de registros para un Proyecto.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
bonito	booleano	Opcional	Indicador que especifica si el cuerpo de la respuesta está en formato legible.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye: `status`: Código de respuesta HTTP `content`: Cuerpo de respuesta esperado	`false`

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Este endpoint no tiene elementos de respuesta.

Solicitud de ejemplo

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest
2      --header "Accept: application/json"
3      --header "Accept: application/gzip"
4      --output logs.tar.gz
5      --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}/download"

Nota

Si utilizas cURL para realizar solicitudes, debes incluir la opción --output y especificar un nombre de archivo para almacenar tus registros.

Respuesta de ejemplo

Encabezado de respuesta

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}

Respuesta del cuerpo

Este endpoint no devuelve un cuerpo de respuesta.

Volver

Obtener tarea

Crear

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest
2	--header "Accept: application/json"
3	--header "Accept: application/gzip"
4	--output logs.tar.gz
5	--request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}/download"