Docs Menu
Docs Home
/ /
Trabajos de recopilación de registros
Docs Home
/ /
Recursos
/
Trabajos de recopilación de registros
Docs Home
/
Gestión
/
Gerente de Operaciones
/
API
/
Recursos
/
Trabajos de recopilación de registros

Consiga un trabajo de recolección de registros

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

Al crear un trabajo de recopilación de registros, Ops Manager inicia un trabajo en segundo plano para descargar los registros de la implementación de Ops Manager especificada. Utilice este punto de conexión para recuperar un único trabajo de recopilación de registros por su identificador único.

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

Resource

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

Parámetros de la ruta de solicitud

Nombre
Tipo
Necesidad
Descripción

ID DE GRUPO

string

Requerido

Cadena de dígitos hexadecimales 24única que identifica el trabajo de solicitud de recopilación de registros.

ID DE TRABAJO

string

Requerido

Cadena única de dígitos hexadecimales 24que identifica el trabajo de recopilación de registros que se reintentará. Utilice el Obtenga todos los trabajos de recopilación de registrospara un punto final del proyecto para obtener los identificadores asociados con su proyecto.

Parámetros de consulta de solicitud

Nombre
Tipo
Descripción
predeterminado

número de página

entero

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

1

artículos por página

entero

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

100

bonita

booleano

Indica si el cuerpo de la respuesta debe estar en un impresión bonita formato.

false

envolvente

booleano

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

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure "envelope" : true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre
Descripción

status

Código de respuestaHTTP

content

Cuerpo de respuesta esperado

Para los puntos finales que devuelven una lista de resultados, el objeto results es un sobre. Ops Manager añade el campo status al cuerpo de la respuesta.

Ninguno

verbose

Booleano

Si es verdadero, devuelve todos los trabajos secundarios en la respuesta. Un trabajo de recopilación de registros contiene trabajos secundarios para cada tipo de registro y proceso de MongoDB incluido en la solicitud.

false

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Nombre
Tipo
Descripción

trabajos infantiles

arreglo

Lista de trabajos secundarios asociados a esta solicitud. Se incluye en la respuesta si se establece el parámetro de consulta verbosa true en.

childJobs[n].mensajeDeError

string

Mensaje de error que muestra por qué falló este trabajo secundario, si corresponde.

childJobs[n].fechaDeFin

string

Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando finalizó este trabajo secundario.

trabajos secundarios[n].nombrehost

string

Nombre del host desde el cual el trabajo secundario recopila los registros.

childJobs[n].logCollectionType

string

Tipo de registro que recopila este trabajo secundario. 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 este trabajo secundario recopila registros. MongoDB Atlas utiliza estas rutas para crear la jerarquía de directorios en el archivo comprimido.

tipo de colección de registros
Ruta de acceso

AUTOMATION_AGENT

<hostname>/automation_agent

AGENTE DE COPIA DE SEGURIDAD

<hostname>/automation_agent

AGENTE DE MONITOREO

<hostname>/automation_agent

Base de datos MongoDB

<hostname>/<port>/<mongodb>

FTDC

<hostname>/<port>/<ftdc>

childJobs[n].fechadeinicio

string

Marca de tiempo en formato ISO,8601 fecha y hora en UTC cuando se inició este trabajo secundario.

childJobs[n].status

string

Estado de este trabajo secundario. Este recurso devuelve uno de los siguientes valores:

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

childJobs[n].bytesdeespaciodediscosincomprimir

Número

Espacio total en disco sin comprimir en bytes que utiliza este trabajo secundario.

fecha de creación

string

Marca de tiempo, en la cantidad de segundos que han transcurrido desde la época de UNIX en la que creó el trabajo de solicitud de recopilación de registros.

expirationDate

string

Marca de tiempo, en la cantidad de segundos que han transcurrido desde la época de UNIX en la que expira el trabajo de solicitud de recopilación de registros.

ID de grupo

string

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

ID.

string

Cadena de dígitos hexadecimales 24única que identifica el trabajo de solicitud de recopilación de registros.

tipos de registro

arreglo

Lista de tipos de registro 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

Bandera que indica si la solicitud reemplaza correos electrónicos, nombres de host, direcciones IP y espacios de nombres en la respuesta con valores de cadena aleatorios.

nombreRecurso

string

Nombre del recurso para el que solicitó registros.

tipo de recurso

string

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

  • CLUSTER

  • PROCESS

  • REPLICA_SET

nombreDeRecursoRaíz

string

Nombre de la implementación completa si se realizó la solicitud de registro a una parte de la implementación. Esta parte podría ser un conjunto de réplicas en un clúster o un fragmento de un clúster fragmentado.

rootResourceType

string

Tipo de la parte de la implementación completa si se realizó la solicitud de registro a una parte de la implementación. Una parte de la implementación podría ser un conjunto de réplicas en un clúster o un fragmento de un clúster fragmentado. Este recurso devuelve uno de los siguientes valores:

  • CLUSTER

  • PROCESS

  • REPLICA_SET

Estado

string

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

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

tamaño solicitado por bytes de archivo

Número

Tamaño de cada archivo de registro en bytes.

sin comprimirTamañoTotalBytes

Número

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

ID de usuario

string

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

URL de descarga

string

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

Ejemplo de solicitud

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"

Ejemplo de respuesta

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}

Cuerpo de respuesta

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