Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
Click here >
Docs Menu
Docs Home
/ /
Tareas de recopilación de registros
Docs Home
/ /
Recursos
/
Tareas de recopilación de registros
Docs Home
/
Gestión
/
Gerente de Operaciones
/
API
/
Recursos
/
Tareas de recopilación de registros

Obtén una tarea de recopilación de registros

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es lo mismo que tu ID del grupo. Para los grupos existentes, su identificador de grupo/proyecto sigue siendo el mismo. Esta página utiliza el término más familiar "grupo" al referirse a descripciones. El endpoint permanece 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 recuperar una única tarea de recopilación de registros mediante su identificador único.

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

Resource

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

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

string única de 24dígitos hexadecimales que identifica la tarea de recolección de registros para reintentar. Usa el Obtenga todos los trabajos de colección de registros para un Proyecto, terminal para obtener los ID asociados con su Proyecto.

Parámetros de Solicitud Query

Nombre
Tipo
Descripción
predeterminado

Num. de pág.

entero

Número de página (basado en índice a partir de 1).

1

elementosPorPágina

entero

Número de elementos a devolver por página, hasta un máximo de 500.

100

bonito

booleano

Indica si el cuerpo de la respuesta debe estar en un(a) pretty-print formato.

false

envelope

booleano

Indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediarlo, establezca "envelope" : true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:

Nombre
Descripción

status

Código de respuesta HTTP

content

Cuerpo de respuesta esperado

Para los endpoints que devuelven una lista de resultados, el objeto results es un sobre. Ops Manager agrega el campo status al cuerpo de la respuesta.

Ninguno

verbose

Booleano

Si es verdadero, devuelve todas las tareas secundarias en la respuesta. Una tarea de colección de registros contiene tareas secundarias para cada tipo de registro y proceso de MongoDB incluidos en la solicitud.

false

Parámetros del cuerpo de la solicitud

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

Respuesta

Nombre
Tipo
Descripción

empleos secundarias

arreglo

Lista de tareas secundarias asociadas con esta solicitud. Incluido en la respuesta si configuras el parámetro de consulta verbose en true.

childJobs[n].errorMessage

string

Mensaje de error que muestra por qué falló esta tarea secundaria, si corresponde.

childJobs[n].finishDate

string

Marca de tiempo en ISO 8601 Formato de fecha y hora en UTC cuando este subproceso se completó.

childJobs[n].hostName

string

Nombre del host del que la tarea secundaria recopila los registros.

childJobs[n].logCollectionType

string

Tipo de registro que esta tarea secundaria recopila. Devuelve uno de los siguientes valores:

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

childJobs[n].path

string

Ruta al proceso en la implementación para el cual esta tarea secundaria recopila registros. MongoDB Atlas utiliza estas rutas para construir la jerarquía de directorios en el archivo comprimido.

logCollectionType
ruta

AUTOMATION_AGENT

<hostname>/automation_agent

BACKUP_AGENT

<hostname>/automation_agent

MONITORING_AGENT

<hostname>/automation_agent

MongoDB

<hostname>/<port>/<mongodb>

FTDC

<hostname>/<port>/<ftdc>

childJobs[n].startDate

string

Marca de tiempo en el formato de fecha y hora ISO 8601 en UTC cuando esta tarea secundaria empezó.

childJobs[n].status

string

Estado de esta tarea secundaria. Este recurso devuelve uno de los siguientes valores:

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

childJobs[n].uncompressedDiskSpaceBytes

Número

Espacio total no comprimido en disco en bytes que utiliza esta tarea secundaria.

creationDate

string

Marca de tiempo, en el número de segundos transcurridos desde la época UNIX cuando creó la tarea de solicitud de colección de registros.

expirationDate

string

Marca de tiempo, en la cantidad de segundos transcurridos desde la época UNIX cuando vence la tarea de solicitud de colección de registros.

ID del grupo

string

string única de 24dígitos hexadecimales que identifica el proyecto asociado con la solicitud de recopilación de registros.

ID

string

Cadena única de 24 dígitos hexadecimales que identifica la tarea de solicitud de colección de registros.

typeslog

arreglo

Lista de tipos de registros incluidos en esta solicitud. Este recurso devuelve uno o más de los siguientes valores:

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

redactado

booleano

Indicador que indica si la solicitud sustituye los correos electrónicos, nombres de host, direcciones IP y espacios de nombres en la respuesta por valores de cadena aleatorios.

nombreDelRecurso

string

Nombre del recurso para el que solicitaste registros.

resourceType

string

Tipo de recurso para el que solicitaste registros. Este recurso devuelve uno de los siguientes valores:

  • CLUSTER

  • PROCESS

  • REPLICA_SET

rootResourceName

string

Nombre de la completa implementación si realizó la solicitud de registro para una parte de una implementación. Parte de la implementación podría ser un set de réplicas en un clúster o una partición de un clúster particionado.

rootResourceType

string

Tipo de la parte de la implementación completa si hiciste la solicitud de registro a una parte de la implementación. Parte de la implementación podría ser un set de réplicas en un clúster o una partición de un clúster fragmentado. Este recurso retorna uno de los siguientes valores:

  • CLUSTER

  • PROCESS

  • REPLICA_SET

Estado

string

Estado de la tarea de solicitud de colección de registros. Este recurso devuelve uno de los siguientes valores:

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

tamañoSolicitadoPorArchivoBytes

Número

Tamaño de cada entrada de registro en bytes.

uncompressedSizeTotalBytes

Número

Tamaño total sin comprimir de los datos del registro en bytes que devuelve esta solicitud.

ID de usuario

string

string única de 24 dígitos hexadecimales que identifica al usuario que ejecuta la solicitud.

downloadUrl

string

Dirección de Internet desde la que descargas los registros de esta solicitud.

Solicitud de ejemplo

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --include \
4     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}?verbose=true&pretty=true"

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

1{
2  "childJobs": [
3    {
4      "automationAgentId": "5c81086e014b76a3d85e1123",
5      "errorMessage": null,
6      "finishDate": "2019-03-07T12:02:57Z",
7      "hostName": "server1.example.com",
8      "logCollectionType": "AUTOMATION_AGENT",
9      "path": "server1.example.com/automation_agent",
10      "startDate": "2019-03-07T12:02:54Z",
11      "status": "SUCCESS",
12      "uncompressedDiskSpaceBytes": 12827
13    },
14    {
15      "automationAgentId": "5c81086e014b76a3d85e1117",
16      "errorMessage": null,
17      "finishDate": "2019-03-07T12:02:57Z",
18      "hostName": "server1.example.com:27027",
19      "logCollectionType": "MONGODB",
20      "path": "server1.example.com/27027/mongodb",
21      "startDate": "2019-03-07T12:02:54Z",
22      "status": "SUCCESS",
23      "uncompressedDiskSpaceBytes": 9292
24    },
25    ...
26  ],
27  "creationDate": "2019-03-07T12:02:54Z",
28  "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download",
29  "expirationDate": "2019-05-06T12:02:54Z",
30  "groupId": "5c8100bcf2a30b12ff88258f",
31  "id": "5c81086e014b76a3d85e1113",
32  "logTypes": [
33    "AUTOMATION_AGENT",
34    "MONGODB",
35    "FTDC"
36  ],
37  "redacted": false,
38  "resourceName": "myReplicaSet",
39  "resourceType": "replicaset",
40  "rootResourceName": "myReplicaSet",
41  "rootResourceType": "replicaset",
42  "sizeRequestedPerFileBytes": 1000,
43  "status": "IN_PROGRESS",
44  "uncompressedSizeTotalBytes": 44518,
45  "userId": "5c80f75fcf09a246878f67a4"
46}

Volver

Obtener todos los trabajos

Next

Descargar registros

En esta página