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 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 24 dígitos hexadecimales que identifica la tarea de colección de registros a reintentar. Utilice el endpoint Obtener todos los trabajos de recolección de registros de un Proyecto para obtener los ID asociados a 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). |
|
elementosPorPágina | entero | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Indica si el cuerpo de la respuesta debe estar en un formato prettyprint. |
|
envelope | booleano | 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 corregir esto, establezca Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:
Para los endpoints que devuelven una lista de resultados, el objeto | 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. |
|
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 |
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 en formato de fecha y hora en UTC cuando finalizó esta tarea secundaria. |
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:
|
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.
|
childJobs[n].startDate | string | Marca de tiempo en ISO 8601 en formato de fecha y hora en UTC cuando se inició esta tarea secundaria. |
childJobs[n].status | string | Estado de esta tarea secundaria. Este recurso devuelve uno de los siguientes valores:
|
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:
|
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:
|
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:
|
Estado | string | Estado de la tarea de solicitud de colección de registros. Este recurso devuelve uno de los siguientes valores:
|
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
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --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 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 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "childJobs": [ { "automationAgentId": "5c81086e014b76a3d85e1123", "errorMessage": null, "finishDate": "2019-03-07T12:02:57Z", "hostName": "server1.example.com", "logCollectionType": "AUTOMATION_AGENT", "path": "server1.example.com/automation_agent", "startDate": "2019-03-07T12:02:54Z", "status": "SUCCESS", "uncompressedDiskSpaceBytes": 12827 }, { "automationAgentId": "5c81086e014b76a3d85e1117", "errorMessage": null, "finishDate": "2019-03-07T12:02:57Z", "hostName": "server1.example.com:27027", "logCollectionType": "MONGODB", "path": "server1.example.com/27027/mongodb", "startDate": "2019-03-07T12:02:54Z", "status": "SUCCESS", "uncompressedDiskSpaceBytes": 9292 }, ... ], "creationDate": "2019-03-07T12:02:54Z", "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download", "expirationDate": "2019-05-06T12:02:54Z", "groupId": "5c8100bcf2a30b12ff88258f", "id": "5c81086e014b76a3d85e1113", "logTypes": [ "AUTOMATION_AGENT", "MONGODB", "FTDC" ], "redacted": false, "resourceName": "myReplicaSet", "resourceType": "replicaset", "rootResourceName": "myReplicaSet", "rootResourceType": "replicaset", "sizeRequestedPerFileBytes": 1000, "status": "IN_PROGRESS", "uncompressedSizeTotalBytes": 44518, "userId": "5c80f75fcf09a246878f67a4"}